swagger

Documentation

Overview

Package swagger 提供 SwaggerUI 的实现

Index

• Constants
• func Install(s web.Server)
• func WithCDN(logo string) openapi.Option
• func WithHTML(assets, logo string) openapi.Option

Constants

const CDNAssets = "https://unpkg.com/swagger-ui-dist@5.18.2"

CDNAssets swagger 的 CDN 资源

Functions

func Install

func Install(s web.Server)

Install 安装模板

NOTE: 此操作会同时安装 json 和 yaml 两个模板函数

func WithCDN

func WithCDN(logo string) openapi.Option

WithCDN 采用 CDNAssets 作为参数的 WithHTML 版本

如果 logo 为空，则会采用 CDNAssets 下的默认图标。

func WithHTML

func WithHTML(assets, logo string) openapi.Option

WithHTML 指定 swagger 的 HTML 模板

可用来代替 openapi.WithHTML

assets swagger 的页面资源，可以直接引用 CDNAssets， 或是采用 files 与 static 搭建一个本地的静态文件服务；