Linkerd 2.10 でサービスプロファイルを構成する実践ガイド
Linkerd の ServiceProfile は、HTTP トラフィックに対するルート単位の可観測性・信頼性制御を可能にするカスタムリソースです。これにより、各エンドポイントごとのメトリクス収集、再試行ポリシー、タイムアウト設定が実現されます。
Linkerd プロキシは、着信 HTTP リクエスト(HTTPS 以外)の宛先サービスを、以下の順序で解析します:l5d-dst-override ヘッダー → : ...
8月1日 03:58 投稿
IBM i RPGシステム向けOpenAPIクライアント自動生成:NSwag活用実践ガイド
NSwagは、.NETベースのオープンソースツールであり、OpenAPI(Swagger)仕様をもとに型安全なクライアントコードを多言語で自動生成する機能を提供します。特に、IBM i上で動作するRPG/400系レガシーアプリケーションを現代的なWebサービスとして公開・連携する際、そのAPIインターフェースを正確かつ効率的に抽象化・利用可能にするための鍵となるツールです。
なぜNSwag ...
7月16日 19:29 投稿
RedocでAPIドキュメントのバージョンをシームレスに切り替える
Redocは、OpenAPI仕様を魅力的かつインタラクティブなドキュメント形式に変換する強力なAPIドキュメント生成ツールです。特に多バージョン対応のAPIを揃える環境において、** version スイッチ機能 **は、開発者やエンドユーザーが異なるAPIバージョンを直感的に比較・参照・切り替えできる点で不可欠です。
この機能は、UI構成要素と設定の柔軟な設計により実現されており ...
7月10日 17:35 投稿
OpenAPIを使用したヘルスチェックAPIの迅速な構築方法
現代のマイクロサービスアーキテクチャにおいて、システムの安定性を確保するためには、サービスの健康状態を効率的に監視することが不可欠です。この記事では、OpenAPIを使って標準化されたヘルスチェックAPIを構築する方法について説明します。
ヘルスチェックAPIが必要な理由
ヘルスチェックAPIは、以下のような役割を果たします:
サービスのリアルタイムな動作状態を ...
6月27日 01:20 投稿
Spring BootにおけるSwagger 2の導入と利用
Swaggerは、OpenAPI仕様に基づいたオープンソースのツール群であり、REST APIの設計、構築、文書化、および利用を支援します。その主な目的は、バックエンドのRESTful APIのテストを容易にし、動的な更新を可能にすることです。バックエンドのAPIが変更された場合、Swaggerは自動的に更新されるため、手動でのテストインターフェースのメンテナンスが不要になります。
...
6月25日 17:53 投稿
Docker ComposeでSwagger UIをデプロイ:複数API管理の効率化
現代のマイクロサービスアーキテクチャでは、APIドキュメントツールの展開は、複雑な認証設定、複数バージョンAPIドキュメントの共存、開発環境と本番環境の乖離という課題に直面しがちです。本稿では、Docker Composeを利用してSwagger UIをコンテナ化し、環境変数による設定、Nginxリバースプロキシ、複数サービス連携を含む包括的なソリューションを提供します。これに ...
6月18日 21:22 投稿
Spring Boot 環境で Redoc を活用した API ドキュメントの構築
OpenAPI 仕様に基づくドキュメント生成の概要
Java ecosystem において、API 仕様の標準化と可視化は開発効率に直結する重要な要素です。Spring Boot プロジェクトでは、SpringDoc を利用して OpenAPI 3.0 準拠の仕様書を自動生成し、それを Redoc というレンダリングエンジンで表示させる構成が一般的です。この組み合わせにより、コードの変更を追従した最新のドキュメ ...
6月4日 19:11 投稿
InfinityにおけるOpenAPI規格の構築とSwagger UI連携ガイド
InfinityのAPI仕様書自動生成メカニズム
Infinityは、高スループットかつ低レイテンシを特徴とするベクトル埋め込み提供のためのREST APIサーバーです。本サービスの開発・統合を円滑に進めるために、OpenAPI規格による仕様書の自動生成と可視化が実装されています。以下では、サーバー起動状態を前提とした仕様書取得ワークフローを解説します。
OpenAPI JSONの取得と検 ...
5月31日 10:44 投稿
JWT ベースの OpenAPI 認可フロー:ThinkPHP と Gin の実装比較
概要
マルチテナント SaaS プラットフォームでは、外部システムがデータを安全に取得できるよう OpenAPI を公開する。本記事では「アプリ鍵 + シークレット」方式で発行される短期 RefreshToken を用いた認可フローを、PHP(ThinkPHP)と Go(Gin)でそれぞれ実装し、設計とコードを比較する。
認可フローのステップ
テナントごとに一意の ClientID / ClientSecret を事 ...
5月21日 17:50 投稿
Swaggerの設定で見落としがちな属性について
永続的な認証の有効化
app.UseSwaggerUI(c =>
{
// Swagger JSONファイルのエンドポイントを指定し、APIドキュメントを読み込んで表示します。
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
// 永続的な認証を有効にします
c.EnablePersistAuthorization();
});
この設定により、トークンを入力した後、毎回再入力する必要がなくな ...
5月18日 10:30 投稿