天天看点

后台接口文档模板

文档模板

### {接口名称}
>{method} HTTP://{ip}:{port}/{path}

**参数**

- `{参数名称}` {描述} {example} 非必填项
   - {枚举值} 如果是枚举类型
- **`{参数名称}`** {描述} {example} 必填项    

**响应** `{响应类型}`

{响应示例代码}

           

example

测试接口

get HTTP://{ip}:{port}/example

参数

  • text

    文本

    112233

  • text1

    文本1

    112233

响应

JSONObject

{
  code: 200,
  data: {
   text1: '112233',
   text: '112233'
  }
}

           

继续阅读