• home
  • about
  • 全ての投稿
  • ソフトウェア・ハードウェアの設定のまとめ
  • 分析関連のまとめ
  • ヘルスケア関連のまとめ
  • 生涯学習関連のまとめ

OpenAPI

date: 2023-11-17 excerpt: OpenAPIについて

tag: OpenAPI


OpenAPIについて

概要

  • RESTful APIのための仕様(Specification)である
  • 以前はSwaggerと呼ばれていた
  • FastAPIの/docsや/redocで表示されるドキュメントはOpenAPIで生成されている

特徴

  • 標準化されたドキュメント
  • クライアントとサーバーのコード生成
    • 仕様書からコードを生成することができる
  • インタラクティブなドキュメント
    • 仕様書から直接APIを試すことができる
  • APIのテストと検証
    • APIの動作をテストし、仕様に準拠しているかどうかを検証することができる


OpenAPI Share Tweet