REST API リンク集
はじめに
REST API関連のリンク集です。
Specification
REST API関連の規格についてのリンク集です。
OpenAPI Specification
https://swagger.io/specification/
Open API です。
webconcepts
Web Conceptsは、web関連の仕様の概要を説明するサイトです。
Organizations
OpenAPI Initiative
OpenAPI Initiativeは、Open API の規格を管理している団体です。Linux foundation の下部組織です。
Tools
OpenAPI.Tools
Open API のツールチェーンのまとめサイトです。
ツールチェーンを以下のカテゴリに分類して紹介しています。
-
コンバーター
OpenAPIやその他のAPI記述形式との間で変換する様々なツール。
-
データ検証ツール
APIのリクエストやレスポンスがAPIの説明と一致しているかどうかをチェックします。
-
スキーマ検証ツール
APIのスキーマが有効なOpenAPIであるかどうかをチェックします。
-
ドキュメント作成
APIの説明をHTML(またはPDF)で表示することで、技術者ではない人でもAPIの操作方法を理解できるようにします。
-
DSL
YAMLを手で書くのは面白くないし、GUIもいらないかもしれないので、Domain Specific Languageを使って好きな言語でOpenAPIを書きましょう。
-
GUI エディター
ビジュアルエディタを使えば、OpenAPIの仕様全体を覚える必要なく、APIを設計することができます。
-
学習
トラフィックに基づいてサードパーティのAPIのドキュメントを取得しようとしている場合でも、OpenAPIが全くない組織でデザインファーストに切り替えようとしている場合でも、学習はAPI仕様を前進させ、最新の状態に保つのに役立ちます。
-
その他
OpenAPIを使って何かをするその他のもの。
-
モックサーバー
スキーマを入力とし、入力されたHTTPリクエストをサンプルレスポンスにルーティングしたり、動的にサンプルを生成したりする模擬サーバーです。
-
パーサー
OpenAPIの記述を読み込み、プログラムで操作できるようにします。
-
SDK ジェネレーター
コンシューマに提供するコードを生成して、HTTPレベルでの対話を回避できるようにします。
-
セキュリティ
OpenAPI記述を詮索することで、気づかなかった攻撃ベクターを探すツールもあります。
-
サーバーの実装
API用のリソースやルートを簡単に作成・実装できます。
-
テスト
コマンドラインやGUIインターフェイスを使って、APIリクエストを素早く実行し、レスポンスをその場で検証することができます。
-
テキストエディタ
テキストエディタでは、OpenAPIの記述中に視覚的なフィードバックが得られるため、ドキュメントがどのように見えるかを確認することができます。
OpenAPI Map
https://openapi-map.apihandyman.io/
OpenAPI Mapは、Open APIのスキーマを可視化するツールです。
こんな感じに可視化できます。
API Style
API Style Book
API スタイルガイドを集めたサイトです。
Discussion