Apiary | Platform for API Design, Development & DocumentationPowerful API Design Stack. Built for Developers. Work together to quickly design, prototype, document and test APIs
API 設計ガイド | Cloud APIs | Google Cloud
フィードバックを送信 API 設計ガイド コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。 変更履歴 はじめに これは、ネットワーク API の一般的な設計ガイドです。2014 年以来 Google 内部で使用され、Cloud API やその他の Google API を設計するときに Google が従うガイドです。この設計ガイドは、外部のデベロッパーへの情報提供と、互いの連携作業の効率化のためにここで共有されています。 Cloud Endpoints のデベロッパーには、このガイドは、gRPC API を設計するときに特に役立つことがあり、そのような場合にはこれらの設計原則を使用することを強くおすすめします。ただし、このガイドの使用は必須ではありません。Cloud Endpoints と gRPC はガイドに従わなくても使用できます。 このガイドは、gR
APIドキュメントの書き方をまとめてみる - あらにわ
背景 転職してサーバサイドエンジニアとして、RESTfulなWebAPIドキュメント書く機会が増えた。 RESTの歴史はそれなりに長いため、仕様書の書き方にもベストプラクティスが確立されている。 なので、今更感もあるが、せっかくなのでまとめてみようと思う。 心構え 出来の良いAPI仕様書をマネすること ユーザの対象を意識すること（社内利用か社外利用など。仕様書で意識するポイントが変わるため） トリッキーな使い方をするエンドポイントは疑う 最低限記載すること 共通項目 ドキュメントのメタ情報（バージョン、更新日付など） 常に必要なパラメータ（認証系） 流入制限 エンドポイント（URI） HTTPメソッド（GET、POST、PUT、DELETE、HEAD、OPTIONS、TRACE、CONNECT） Description（概要） Notes（備考） リクエストについて パラメータ（クエリパラ
Dash – Snippet Manager, Documentation Browser
Overview Dash is an API Documentation Browser and Code Snippet Manager. Dash instantly searches offline documentation sets for 200+ APIs, 100+ cheat sheets and more. You can even generate your own docsets or request docsets to be included. Supported Documentation Sets Dash comes with 200+ offline documentation sets. You can choose which documentation sets to download and Dash will take care of the
aglioでAPI Blueprintを使ったドキュメント作成環境をローカルに構築する - dackdive's blog
（2016/11/24追記） 少々アップデートしました。 （追記ここまで） 以前、API ドキュメンテーションツールを色々検討していて Apiary.io を使ってみたんですが その時一緒に調べて気になっていた aglio というツールも試してみたところ、 どうやら自分にはこちらの方が合ってる気がしたのでインストール方法などメモ。 参考にさせていただいた記事 使用するツールはすべて npm でインストール可能なものだが、環境構築については gulp を使う。 gulpfile.js についてはほとんどこちらのコピー。 API 設計ドキュメントをGitHubのプルリクでレビューしつつ Apiary みたいに使うには - Qiita 特に、md (markdown) ファイルを複数ファイルに分割して管理する方法は非常に参考になりました。 使うツール aglio HTML ドキュメント生成ツール
GitHub API v3 | GitHub Developer Guide
Delivering deploymentsUsing the Deployments REST API, you can build custom tooling that interacts with your server and a third-party app. Using the REST API to interact with checksYou can use the REST API to build GitHub Apps that run powerful checks against code changes in a repository. You can create apps that perform continuous integration, code linting, or code scanning services and provide de
APIドキュメントを生成するためのMarkdown拡張API BluePrintとその周辺のライブラリ - Qiita
API Blueprint(以下Blueprint) は MarkdownファイルからAPIドキュメントやサンプルデータになる JSONを生成する仕様。 一旦決められたフォーマットのJSONに吐き出すので、 それを中心に入出力のライブラリが色々あったりする。 Blueprintのパーサー MarkdownからJSONを出力するために Snow Crashというライブラリを利用する。 後に書くものは大体このSow Crashを利用するので詳細は省略。 BlueprintからAPIドキュメントHTMLを生成する Blueprintを上手く扱うために、 色々なライブラリが用意されている。 aglioはBlueprintから表示用htmlを用意してくれるライブラリ。 # output.htmlにファイル出力 $ aglio -i input.md -o output.html # デフォルトの h
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ドキュメント