web-dev-qa-db-ja.com

SwashbuckleでAPIの説明を追加するにはどうすればよいですか？

私はSwashbucklまたはSwaggerを初めて使用しますが、クライアントからSwaggerを使用してドキュメントを作成する必要があるWebAPIを作成しました。すでに作成しましたが、APIバージョンの詳細をSwageer UIに表示する必要がありますが、その方法がよくわかりません。

これが私のコードです：

public class SwaggerConfig
{
    public static void Register()
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        GlobalConfiguration.Configuration
            .EnableSwagger(c =>
                {
                    c.SingleApiVersion("v1", "Demo Api");
                    c.IncludeXmlComments(string.Format(@"{0}\bin\WebApi.XML",
                                         System.AppDomain.CurrentDomain.BaseDirectory));
                })
        .EnableSwaggerUi();

    }
}

コントローラの例：

     /// <summary>
    /// Get the Next IdKey
    /// </summary>
    /// <remarks>Get the Next IdKey from Dettagli Table</remarks>
    /// <response code="404">Not found</response>
    /// <response code="500">Internal Server Error</response>
    [HttpGet]
    public int GetNextIdDettagli()
    {
        try
        {
            DettagliRepo repo = new DettagliRepo();
            return repo.GetNextIdDettagli();
        }
        catch (Exception ex)
        {
            throw (ex);
        }
    }

これは、すべてのコントローラーアクションが行われた方法です。

SwaggerUIの出力は次のとおりです。

enter image description here

これは、1、2、および3でマークされたクライアントからの期待される出力です。

enter image description here

スクリーンショットから、APIの説明、タイトル、その他の情報を表示したいことがわかりますが、表示方法がわかりません。私を助けてください、または私がその部分を達成する方法を私に提案してください。前もって感謝します。

更新

次のリンク から1と2を達成しました

次のコードで：

                   .EnableSwagger(c =>
    {
        c.RootUrl(req => GetRootUrlFromAppConfig());

        c.Schemes(new[] { "http", "https" });

        c.SingleApiVersion("v1", "Swashbuckle.Dummy")
            .Description("A sample API for testing and prototyping Swashbuckle features")
            .TermsOfService("Some terms")
            .Contact(cc => cc
                .Name("Some contact")
                .Url("http://tempuri.org/contact")
                .Email("[email protected]"))
            .License(lc => lc
                .Name("Some License")
                .Url("http://tempuri.org/license"));
    });

しかし、それでも私はポイント3の助けが必要です。ありがとう。

c#asp.net-mvcapiswaggerswashbuckle
8
barsan

実際にドキュメントフィルターを作成し、ドキュメントフィルターを使用してSwaggerドキュメントのTagsノードを更新できます。

以下のサンプルドキュメントフィルターを参照してください。

public class DocumentFilter : IDocumentFilter
{
    /// <summary>
    /// This method is for applying the filter
    /// </summary>
    /// <param name="swaggerDoc">Swagger Document</param>
    /// <param name="schemaRegistry">Schema Registry</param>
    /// <param name="apiExplorer">API Explorer</param>
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
    {
        var methods = swaggerDoc.paths.Select(i => i.Value);
        List<string> tags = new List<string>();
        foreach (var method in methods)
        {
            if (method.delete != null)
            {
                tags.AddRange(method.delete.tags);
            }

            if (method.get != null)
            {
                tags.AddRange(method.get.tags);
            }

            if (method.put != null)
            {
                tags.AddRange(method.put.tags);
            }

            if (method.post != null)
            {
                tags.AddRange(method.post.tags);
            }

            if (method.patch != null)
            {
                tags.AddRange(method.patch.tags);
            }                
        }

        swaggerDoc.tags = new List<Tag>();
        foreach (var tag in tags)
        {
            swaggerDoc.tags.Add(new Tag() { name = tag, description = "This is a group of methods for " + tag });
        }
    }
}
7
Silly John