プロジェクト内部で使用するための Web API をセットアップします。私たちの API を文書化する良い方法を探しています。ウェブを検索して見つけました
これらのツールは、たとえば Java 用に自動的に作成できる JSON ファイルを読み込みます。私たちの API は成長しており、JSON を手動で作成するのが好きですが、テキスト エディターで手動で作成するのは好きではありません。記述的な JSON を手動で作成する負担を軽減するツールまたはフロントエンドはありますか?
一方、Web API のドキュメント化に推奨されるツールは何ですか?
私は .NET (C#) ショップで働いており、swagger を使用して API を文書化しています。ご要望を実現するためのツールが見つからなかったので、独自のツールを作成しました。私は、swagger がそのようなユーティリティ プロジェクトを生み出すほど成熟しているとは思いません...まだです。
swagger のドキュメントで説明されている json オブジェクトを表すクラスを作成することは、それほど難しくありませんでした。これらのインスタンス化されたクラスを取得し、JSON シリアライザーを介して実行して、エンドポイントを記述する個々の json ファイルを取得するだけです。
頑張ってください！