オープンデータとプログラミング

Api を文書化します。|Documenting APIs

オープンデータ関連のニュースです。

https://project-open-data.cio.gov/v1.1/api/

日本語

機関がプライベート、内部、および一般向けの web Api エンタープライズ データのインベントリと公開データ一覧 data.json ファイルの一部として表示されます。元 v1.0 スキーマ Api のリストを個別のフィールドに収容が v1.1 のスキーマと Api べきデータセット内で別のディストリビューションとしては表示されます。としてプライマリ API ドキュメントの URL を使用してすべての web Api を参照する必要があります API ドキュメントの API にアクセスするために必要なプライマリ URL を API は、データセットへの間接アクセスを提供しますので、”API”として指定します。
続きを読む…

English

Agencies should list private, internal, and public-facing web APIs as part of their Enterprise Data Inventory and Public Data Listing data.json files. The original v1.0 schema accommodated the listing of APIs with a separate field, but with the v1.1 schema, APIs should now be listed as a separate distribution within a dataset. Since an API provides indirect access to a dataset and the primary URL that a user needs in order to access the API is the API documentation, all web APIs should be referenced using the primary API documentation URL as an with the specified as “API”.
Read more…

Comments are closed.