VB.NETのASP.NET Web APIでSwagger。ついでに読み込むドキュメントのファイル名を設定

VB.NETでSwaggerを使います。まずはインストール。

Install-Package Swashbuckle -Version 5.4.0

ドキュメントがデフォルトで問題なければ、SwaggerConfig.csを以下のURLを参考にVB.NETで作成して完了。

Issue with VB.NET #85
https://github.com/domaindrivendev/Swashbuckle/issues/85

 

今回は、ドキュメントファイル名を指定するので少々変更。

Imports System.Web.Http
Imports WebActivatorEx
Imports Swashbuckle.Application
<Assembly: PreApplicationStartMethod(GetType(SwaggerConfig), "Register")> 

Public Class SwaggerConfig
    Public Shared Sub Register()
        Dim thisAssembly = GetType(SwaggerConfig).Assembly
        GlobalConfiguration.Configuration.EnableSwagger(Sub(c)
                                                            c.SingleApiVersion("v1", "WebApplication1")
                                                                c.IncludeXmlComments(GetXmlCommentsPath())
                                                        End Sub).EnableSwaggerUi()

    End Sub

    Private Shared Function GetXmlCommentsPath() As String
        Return String.Format("{0}\bin\Hoge.xml", AppDomain.CurrentDomain.BaseDirectory)
    End Function

End Class

Visual Studio 2015 で VB.NETのプロジェクトだと、XMLドキュメントファイル名を指定できなかったのでプロジェクトファイル(.vbproj)をエディタなどで修正。

<DocumentationFile>Hoge.xml</DocumentationFile>

swagger1

 

ということで無事設定完了。

swagger

Comments are closed.

Post Navigation