20分以内でGitHub上のAPIリポジトリ

さて、あなたはswagger.ioサイトにいるので、APIのOpenAPI仕様を作成するか、すでにお持ちかもしれません。GitHubで公開してみませんか?

GitHubでの仕様公開

OpenAPI仕様を持つGitHubリポジトリにはいくつかの利点があります

  • GitHub Pagesでのホスティング(完璧な稼働時間、CDN、Jekyll、CNAME付きカスタムドメイン)
  • GitHubコミュニティでの宣伝
  • 改訂履歴、ブランチ、CI
  • 迅速なオンボーディング時間(GitHubの使い方は誰もが知っているはずです)

しかし、主な利点はコミュニティの参加です。APIユーザーはPRやIssuesを開いてフィードバックを提供できます。下のスクリーンショットでSpotifyの例をご覧ください。

多くの大手企業がすでにこのトレンドに従っています

GitHubリポジトリを作成し、そこに仕様を置くのは非常に簡単ですが、ある時点で検証、ドキュメント生成、デプロイなどの機能を実装する必要があります。

私たちにお任せください!

私たちAPIs.guruは、Rebilly Inc.のためにこのようなリポジトリをセットアップする契約をしました。Rebillyはこのソリューションを気に入って、内部/実験的なAPIのために同様のリポジトリを求めました。彼らは親切にも、GitHubホスト型APIポータルのオープンソース自動ジェネレーターであるgenerator-openapi-repoの開発を後援してくれました。

このようなリポジトリをセットアップするために必要なのは、私たちのツールを実行し、いくつかの非常に簡単な質問に答えることだけです。

今すぐお試しください!

非常に簡単なので、今すぐお試しいただくことをお勧めします。

20分以内に、以下の便利な機能を備えたGitHubでホストされるAPIリポジトリが完成します。

  • Travisでの継続的インテグレーション/デプロイ
  • 個別のファイルとしてのコードサンプルサポート
  • コミット後のOpenAPI仕様の検証
  • ReDoc + SwaggerUIをGithub Pagesでホスト(カスタムドメインも使用可能)
  • お気に入りのエディタまたはswagger-editorでのライブ編集

GitHubリポジトリで問題や機能リクエストを遠慮なく開いてください。