search

JsonMa / swagger-egg

Eggjs Swagger-UI API文档自动生成插件（如果喜欢请点赞支持）。Egg swagger documentation generator（welcome to star this project）.
MIT License
44 stars 16 forks source link

请问想在apifox里配置出post请求，参数取json，controller里应该怎么配置呢 #27

Closed MZSY closed 2 years ago

MZSY commented 2 years ago

我想在apifox里配置post请求，一般我的post请求都是用的json格式，不是x-www-form-urlencoded的格式，现在我在controller里配置 * @description #parameters userid formData string true - 用户id 导入到Apifox以后变成了x-www-form-urlencoded的参数，这样的参数拿到格式不对，请教一下怎么配置

JsonMa commented 2 years ago

application-json只能放到请求的body里面，所以应该写成 * @description #parameters userid body schema true - 请求体，参考下这个示例

MZSY commented 2 years ago

好的，我试了可以实现，非常感谢！另外想问下，类似的配置型样例有比较完整的吗，还是就只有您回复里的那个链接地址那些？ 我想在body里配置成简单的json串作为传参样例，类似这样的可以吗 test

JsonMa commented 2 years ago

好的，我试了可以实现，非常感谢！另外想问下，类似的配置型样例有比较完整的吗，还是就只有您回复里的那个链接地址那些？ 我想在body里配置成简单的json串作为传参样例，类似这样的可以吗 test

可以的，application-json可以传数组、字符串、布尔值、数字。网上搜一下很容易搜到。

MZSY commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

JsonMa commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

MZSY commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

我的意思是，之前不是问过您怎么把application-json写到controller里吗？这个写入controller并导入到apifox我已经实现了，但是导入进去以后每次调用默认自动生成的是个空的对象，需要手动重新填一遍keyvalue值。那么这个对象参数能不能通过在controller里配置达到生成指定的body格式？ 2-2 2-1

JsonMa commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

我的意思是，之前不是问过您怎么把application-json写到controller里吗？这个写入controller并导入到apifox我已经实现了，但是导入进去以后每次调用默认自动生成的是个空的对象，需要手动重新填一遍keyvalue值。那么这个对象参数能不能通过在controller里配置达到生成指定的body格式？ 2-2 2-1

definitions也是需要你去schema文件中定义的，这个没办法自动生成哦。

MZSY commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

我的意思是，之前不是问过您怎么把application-json写到controller里吗？这个写入controller并导入到apifox我已经实现了，但是导入进去以后每次调用默认自动生成的是个空的对象，需要手动重新填一遍keyvalue值。那么这个对象参数能不能通过在controller里配置达到生成指定的body格式？ 2-2 2-1

definitions也是需要你去schema文件中定义的，这个没办法自动生成哦。

swagger-egg/example/egg-swagger-ts-schema-example/ 这个路径下的配置可以参考吗

JsonMa commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

我的意思是，之前不是问过您怎么把application-json写到controller里吗？这个写入controller并导入到apifox我已经实现了，但是导入进去以后每次调用默认自动生成的是个空的对象，需要手动重新填一遍keyvalue值。那么这个对象参数能不能通过在controller里配置达到生成指定的body格式？ 2-2 2-1

definitions也是需要你去schema文件中定义的，这个没办法自动生成哦。

swagger-egg/example/egg-swagger-ts-schema-example/ 这个路径下的配置可以参考吗

这是TS的示例，如果你不是用的TS就没有参考意义。

MZSY commented 2 years ago

我指的是，在代码controller层，swagger那里配置好了直接导入到apifox里可以自动生成这样一种格式的json，能实现吗 * @description #parameters body body body true - 用户数据体 我这样配置body只能出这样的结果 1

你说的是把swagger.json文件导入到apifox里面么？

我的意思是，之前不是问过您怎么把application-json写到controller里吗？这个写入controller并导入到apifox我已经实现了，但是导入进去以后每次调用默认自动生成的是个空的对象，需要手动重新填一遍keyvalue值。那么这个对象参数能不能通过在controller里配置达到生成指定的body格式？ 2-2 2-1

definitions也是需要你去schema文件中定义的，这个没办法自动生成哦。

swagger-egg/example/egg-swagger-ts-schema-example/ 这个路径下的配置可以参考吗

这是TS的示例，如果你不是用的TS就没有参考意义。

好的，那我再研究一下，感谢解答