doc

README

导出文档

基于 IRIS ( iris web framework ) 项目, 导出 markdown 格式文档.

go run main.go gen:doc

接受 config/console.yaml 配置

commands:
  gen:doc:
    options:
      base-dir: "./"
      controller-dir: "app/controllers"
      output-dir: "docs/api"

注解

• @Error
• @Ignore - Do not export, default is false.

  // @Ignore
  // @Ignore(true)
  // @Ignore(false)
  

• @Request
• @Response
• @Route - A
  • @Delete - A
  • @Get - A
  • @Head - A
  • @Options - A
  • @Patch - A
  • @Post - A
  • @Put - A
• @RoutePrefix - A C
• @Summary

标签

• desc

  Name string `desc:"about the name"`
  

• label -

  Name string `label:"Name" desc:"Name of the user" mock:"John"`
  

• mock
• validate

  Name string `validate:"required,min=3,max=10"`
  

Documentation

Index

• func New() console.Command

Examples

• New

Functions

func New

func New() console.Command

New creates a new console.Command.

Example

c := console.New()
c.Add(New())
c.Run()