This is a tool and Golang package that uses swagger2.0 definitions to generate API static documents (such as pdf) based on template files.

  • By zc
  • Last update: Sep 19, 2022
  • Comments: 0

apidoc

LICENSE GoDoc Go Report Card

English | 简体中文

This is a tool and Golang package that uses swagger2.0 definitions to generate API static documents (such as pdf) based on template files.

Preconditions

The wkhtmltopdf package must be installed.

Installation

Source Code

go install github.com/zc2638/apidoc/cmd/apidoc@latest

Use

From File

apidoc --src <your-swagger-json> [--dest <your-output-dir>]

From URL

apidoc --src https://petstore.swagger.io/v2/swagger.json

Toolkit Example

Please visit the example

Download

apidoc.zip