apidoc

README

apidoc

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.

Installation

1、Source Code

Preconditions

The wkhtmltopdf package must be installed.

• MacOS: brew install Caskroom/cask/wkhtmltopdf
• multiple operating systems can be found at https://wkhtmltopdf.org/downloads.html.

Install Command

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

2、Docker

docker pull zc2638/apidoc:latest

Use In Docker

docker run --rm zc2638/apidoc:latest --src https://petstore.swagger.io/v2/swagger.json --data > petstore.pdf

Use In Command

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

Documentation

Index

• func Parse(content []byte) ([]byte, error)
• func ParseFromURL(url string) ([]byte, error)
• func SaveToPDF(data []byte, isGray bool) ([]byte, error)
• func SaveToPDFFile(data []byte, isGray bool, to string) error

Functions

func Parse

func Parse(content []byte) ([]byte, error)

func ParseFromURL

func ParseFromURL(url string) ([]byte, error)

func SaveToPDF

func SaveToPDF(data []byte, isGray bool) ([]byte, error)

func SaveToPDFFile

func SaveToPDFFile(data []byte, isGray bool, to string) error