nginx怎么写api接口

---

🕛怎么写api接口

---

一些刚开始写前端文档的后端同学，倾向于根据代码思路来写前端文档。 这导致学生客户或者对接团队技术人员经常抱怨看不懂接口文档。 本文介绍了一种编写通用接口文档的方法。

编写接口文档，推荐使用docway，方便保存和分享。 支持PDFMARKDOWN导出，支持小组项目管理。

1.请求参数

1.请求方法

GET

用于接收数据

POST

用于更新数据，与PUT可互换，语义上PUT支持幂等性。

PUT

用于添加新数据，可与POST互换。 从语义上看，PUT支幂等

DELETE

删除数据

其他

其他请求方法在常用接口中很常见。 谨慎使用。 例如：PATCHHEADOPTIONS

2.URL

url代表接口请求路径。 该路径可以包含称为地址参数的参数，例如**/user/{id}**，其中标识符用作参数。

3.HTTPHeader

HTTPHeader用于本次请求的基本信息，在接口文档中以K-V方式展示——这是一个非常必要的描述头。 请求正文数据类型。

常用的内容类型：

application/x-www-form-urlencoded

请求参数使用“&”字符连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容由分隔符分隔的多个数据组成

4.HTTPBody

描述httpbody，依赖于具体数据在体型上。 如果body中的数据是对象类型。 然后需要描述对象中字段的名称、类型、长度（不能为空）、默认值和描述。 这最好用表格来表达。

示例：

2.响应参数

1.响应的HTTPBody

响应的正文与请求的正文相同。 如果您需要描述类型，请清除数据。

另外，如果服务根据不同的httpstatuscode返回不同​​的数据结构，也需要针对不同的httpstatuscode描述内容。

3.接口描述

描述该接口的使用场景、需要特别关注的地方，例如接口是否幂等、处理是同步还是异步等。

4．示例

上一个示例（红笔圈出关键点，熟记于心）：

5.界面工具

。 >

编写接口文档，推荐使用http://docway.net（原名逍遥集），方便保存和分享。 它支持PDFMARKDOWN导出和分组项目管理。

---

🐗nginx配置域名如何进行jsapi鉴权？

---

配置nginx中同一个域名的所有子域名可以放在nginx配置文件页面的指定位置。 server_name选项可以在服务器配置中设置，如下所示：server{server_name*.2***.com2***.com;#其他配置}保存配置文件后，重新启动nginx即可生效。