https://github.com/donnol/httpdoc

Auto genrate http interface document.
https://github.com/donnol/httpdoc

doc go http

Last synced: 21 days ago
JSON representation

Auto genrate http interface document.

• Host: GitHub
• URL: https://github.com/donnol/httpdoc
• Owner: donnol
• License: mit
• Created: 2018-07-23T14:04:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-27T14:00:18.000Z (about 7 years ago)
• Last Synced: 2025-01-24T20:21:51.889Z (9 months ago)
• Topics: doc, go, http
• Language: Go
• Size: 12.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# httpdoc

Auto genrate http interface document.

JSON 文档格式

```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 文档格式

```toml

# TODO

```