ドキュメント用に標準の HelpPages 領域を使用する Web API プロジェクトを実装しています。私は自分のプロジェクトで属性ルーティングを使用し、ApiVersioning を実装しています。メソッドとモデルのほとんどを文書化しましたが、API バージョンのルート パラメーターを文書化する方法を見つけようとしています。これが私のコントローラーの例です:
/// <summary>
/// Controller for the License api.
/// </summary>
[ApiVersion("1.0")]
[RoutePrefix("api/v{version:apiVersion}/license")]
public class LicenseController : ApiController
{
#region Software License Methods
/// <summary>
/// Creates a new Software License.
/// </summary>
/// <param name="value">The parameters for the license.</param>
/// <returns>The newly created Activation and Emergency Ids.</returns>
[Route("software")]
[HttpPost]
public LicenseCreateResponse CreateSoftwareLicense([FromBody] CreateSoftwareLicenseRequest value)
{
// License creation code
}
HelpArea を構成してプロジェクトを実行すると、次のヘルプ情報が表示されます。
version パラメーターの説明がありますが、それを文書化する方法がわかりません。メソッドに関する限り、ルートの一部ではないため、試し<param name="version">...
ても無駄です。
助けてくれてありがとう!