今週のSwagger Spotlightは、OpenAPI SpecificationとSwaggerツールを使ってAPIを構築している個人からのWeb上の最新コンテンツをまとめたものです。
今週の Swagger Spotlight は、OpenAPI SpecificationとSwaggerツールを使ってAPIを構築している個人からのWeb上の最新コンテンツをまとめたものです。今週の記事は私たちが厳選しましたが、次回の Swagger Spotlight にSwagger Blogで取り上げるための投稿も受け付けています。Swagger Spotlightの特集記事を書きたい場合は、こちらで募集している内容を確認し、今日あなたのトピックを提出してください。あなたが取り組んでいるプロジェクトの認知度を高めたい、またはSwaggerツールに関する知識を共有したい場合は、ぜひご連絡ください！
ICYMI – 先週のSwagger Spotlight特集
この記事では、Thomas PolletがGitHub上の彼のプロジェクトを使って、PythonでOAS仕様とSwagger UIドキュメントを自動生成する方法を解説します。彼はオープンソースのpython-pipパッケージ、safrsを作成しました。safrsは、使用されている主要なテクノロジーであるSqlAlchemy、Flask-Restful、Swaggerの頭文字をとったものです。彼はこのフレームワークの目的は、Python開発者がsqlalchemyデータベースオブジェクトと関係のための自己文書化JSON APIを作成するのを助けることだと説明しています。
私が初めてSwaggerを知ったのは数年前、nutanix REST APIを使ってシステム監視アプリを実装しなければならなかったときでした。それはWebサービスをデバッグし、文書化するのに本当に便利な方法だと感じました。その後、別のプロジェクトでドキュメントを提供するよう求められたとき、私はSwagger (現在のOpenAPI) に戻り、仕様を実装しました。
今日のほとんどのWebサービスと同様に、このプロジェクトのAPIエンドポイントはCRUD機能を提供していました。つまり、データベースバックエンドへの作成、読み取り、更新、削除操作です。仕様で記述する必要がある情報の多くは、すでにアプリケーションに暗黙的にコード化されていたため、手動で仕様を書き出す代わりに、利用可能なアプリケーションセマンティクスを使用して生成することにしました。
詳細を読む
この記事では、APIテストにSwagger UIを使用する方法を読者に説明します。まず、Swagger UIの基本、それが素晴らしいツールである理由に触れ、その後、それを使ってAPIをテストする方法のチュートリアルに移ります。Swagger UI内で手動テストを行いたい人にとっては非常に役立ちます。このチュートリアルは、簡単に理解でき、わかりやすいです。使用されている例 (http://petstore.swagger.io/v2/swagger.json) に沿って進めることもできますし、自分のURLで試すこともできます。
この記事では、Swagger UI を API テストに使う方法を紹介します。まず、Swagger UI とは何か、なぜ使う価値があるのかを議論し、それからチュートリアルに進みます。
Swaggerとは？
Swagger（現在はLinux Foundationの傘下にあるOpenAPI Initiativeとして知られています）は、ソースコードの知識が乏しい開発者やテスターでも簡単に読み理解できる共通言語を使ってAPIを記述するためのフレームワークです。それは家の設計図のようなものと考えることができます。好きな建築材料を使用できますが、設計図のパラメータから外れることはできません…
詳細を読む
この投稿では、Nikolaos Georgiou氏が、JavaとSpring Bootを使用してSwaggerツールとOASでREST APIを構築する方法について語っています。彼はSwagger Codegenを使用してSpringでAPIを構築することに焦点を当てています。彼は情報をよく知る必要性を強調し、コードを明確に生成する方法を説明しています。Springでのコード生成に関する詳細情報をお探しの方はこちらをご覧ください。
この投稿では、Swagger を使って Java と Spring Boot で REST API を構築します。Swagger は API フレームワークです。YAML ベースの言語を使って API を定義し、複数の言語をサポートするコードジェネレーターを備えています。
ツール
Swaggerはオンラインエディタを提供しており、言語を試したり構文に慣れたりするのに便利です。しかし、コードを生成するには、ローカルにコードジェネレータがあると便利です。
エディタの左側にはYAML構文が表示されます。右側には、YAML定義を変更するとリアルタイムで更新されるAPIのプレビューが表示されます…
詳細を読む
このガイドでは、スキーマファースト（デザインファーストと呼ばれることもある）APIデザインの背後にある戦略と、OpenAPI仕様を開始するためにSwaggerツールを使用する方法を紹介します。Yos Riadyは、OpenAPI仕様を念頭に置いてデザインすることの利点を非常にうまく強調しています。これは非常に深く掘り下げられており、OASによるデザインの長所と短所を比較検討している場合に貴重なリソースです。
APIを構築しているとします。
いくつかのエンドポイントを持つバックエンドサービスを開発し、本番環境にデプロイします。公式の言語固有のAPIクライアントとAPIドキュメントを公開します。その日はハッピーエンドで終わります。
翌日、APIに新機能が追加されました。あなたは以下のことをしなければなりません。
- 新機能をサポートするためにサーバー実装を更新する。
- すべてのクライアントライブラリを更新する（サポートされているプラットフォームと言語ごとに1つのSDK）。
- ドキュメントを更新する。
- 上記すべてが互いに整合している必要があります。
- また、バックエンドAPIが完成するまで、フロントエンドチームはブロックされます。
あなたは深いため息をつきます。もっと良い方法はないのでしょうか？…
続きを読む
あなたのSwaggerを共有してください
あなたの作品をSwaggerブログで紹介してもらいたいですか？Swagger Spotlightは、私たちの考える人や創造する人のコミュニティが、Swaggerコミュニティの他のメンバーと共有する機会です。私たちは常に、人々がSwaggerツールで何を構築しているかを見ることに興味があり、このコミュニティが行っている素晴らしい仕事に光を当てることを信じています。