OpenAPIだってLintしたい - Qiita
$ spectral lint petstore.yaml /work/petstore.yaml 2:6 warning info-contact Info object must have "contact" object. info 2:6 warning info-description Info "description" must be present and non-empty string. info 11:9 warning operation-description Operation "description" must be present and non-empty string. paths./pets.get 15:11 warning operation-tag-defined Operation tags must be defined in global
OpenAPI仕様なAPIの更新監視について - Qiita
背景 私達のプロダクトでは、外部サービスとの連携機能を提供しています。 これらの機能は、外部サービスが公開しているOpenAPI仕様のAPIドキュメントに基づいて実装されています。連携先サービスの仕様変更は私達がコントロールできるものではなく、連携先の都合により実施されます。 その中には私達の提供機能に直接的な影響を与える破壊的な変更も含まれます。これらの変更を迅速に察知し、適切に対応できるようにしたい、というのが発端です。 監視方法の探索 最初のアプローチとして、API仕様書の変更を検知するために古典的なdiffコマンドの利用を検討しました。 しかし、仕様書がJSONやYAML形式で記述されているため、単なるテキスト比較では変更の影響を正確に判断するのが難しいことは明らかです。 例えば、レスポンスのスキーマ定義が変更された場合、その影響範囲を正しく把握するには、各使用箇所を詳細に検証する
openapi-generatorを使ってOpenAPI定義ファイルからGoコードを生成する - LayerX エンジニアブログ
こんにちは、バクラク事業部 バクラクビジネスカード開発チームでEMとTechLeadを担当している高江 @shnjtk です。 今回は、openapi-generator を使ってOpenAPI定義ファイル(OpenAPI Specification)からGoのコードを生成する方法と、運用時のTipsについてご紹介します。 背景 バクラク事業部では、スキーマ駆動開発によりDBやGraphQLのスキーマ定義、OpenAPI定義ファイルなどから自動生成されたコードを積極的に利用する開発スタイルが採用されています。 OpenAPIについては、これまでは go-swagger を利用していましたが、対応しているバージョンが OpenAPI v2.0 までであるため、OpenAPI v3.0 に準拠したOpenAPI定義ファイルからはコードの生成ができませんでした。 自社開発のAPIであればバージョ
OpenAPIドキュメントから全APIの自動テストを生成する - Qiita
はじめに グロースエクスパートナーズ Advent Calendar 2020 3日目。 yitoです。 API開発をしている中で、テストするのに毎回クライアントツールにリクエストを用意してAPIを呼び出すのが手間でした。 それを、コマンド一発で、API仕様書に定義した全てのAPIをテストできるようにしたので、その方法を紹介します。 概要 OpenAPIドキュメントをAPIクライアントツールで利用可能なJSONに変換し、それをCLIライブラリで実行します。 これを実現する、以下について順番に説明していきます。 Postmanについて OpenAPI 3.0 to Postman Collection v2.1.0 Converter Postman Collection SDK newman Postmanについて APIリクエストのクライアントツールにPostmanがあります。 Post
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
