asp.net Web API アプリケーションのドキュメント ツールまたはジェネレーターを探しています。このツールでは、API メソッドまたはパラメーターの説明/概要を編集できる必要があります。これは、PM や QA などのさまざまなチームがドキュメントを編集できるようにするために必要になる場合があります。これにより、必ずしも開発者である必要はありません。
この要件をサポートする優れたツールを提案してください。
asp.net Web API アプリケーションのドキュメント ツールまたはジェネレーターを探しています。このツールでは、API メソッドまたはパラメーターの説明/概要を編集できる必要があります。これは、PM や QA などのさまざまなチームがドキュメントを編集できるようにするために必要になる場合があります。これにより、必ずしも開発者である必要はありません。
この要件をサポートする優れたツールを提案してください。
私たちは Swagger を使用して API を文書化してきました。この Nuget パッケージ Swashbuckle は、API プロジェクトに Swagger を追加します。https://github.com/domaindrivendev/Swashbuckle
ドキュメントは XML コメントで作成され、API をテストすることもできる優れた UI インターフェイスに表示されます。
返信ありがとうございます。仰るとおりです。
現在、既存の xml ドキュメントから生成されるオンライン ドキュメントのツールを探しています。そのオンライン ドキュメントは、チーム メンバーによってさらに編集され、公開される可能性があります。