Include dev API in docs

オープン
#421 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
openapi
領域
api, documentation

調査の方向性

この issue は公開 REST API と Swagger 定義を特定していますが、ファイル名やエントリポイントは示していません。まず API 仕様とドキュメントサイトの統合ポイントを見つけてください。完了の条件は、公開 API がカスタムインテグレーターにとって使いやすい形式でドキュメント化されていることです。

索引モデルが issue の本文から書いたものです。

説明

cloud/server

if we have swagger definition of the public REST API it should be possible to easily create nice documentation for anyone who would like to use it for custom integrations

主要言語
Vue
スター
15
フォーク
22
平均マージ
6日 7時間
マージ済み PR(30日)
10

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

MerginMaps/docs のほかの issue

MerginMaps/docs の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。