Skip to content

donnol/httpdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

httpdoc

Auto genrate http interface document.

JSON 文档格式

{
  "method": "GET",
  "url": "http://host:port/api/getXXXList",
  "param": {
    "size": {
      "type": "int",
      "require": false,
      "comment": "分页大小",
      "default": 10
    },
    "offset": {
      "type": "int",
      "require": false,
      "comment": "分页偏移"
    }
  },
  "return": {
    "data": [
      {
        "id": {
          "type": "string",
          "comment": "数据id"
        },
        "name": {
          "type": "string",
          "comment": "数据名"
        }
      }
    ],
    "total": "int"
  }
}

TOML 文档格式

# TODO

About

Auto genrate http interface document.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages