Swagger on Sawyer Zheng's Blog

flask-restx notes

Thu, 17 Jun 2021 00:00:00 +0000

教程

Api 类教程

namespace

作用：对 Resource 分组
参考：API — Flask-RESTX documentation–Namspace class
调用
1

api.namespace(...)

Model

参考：
- API — Flask-RESTX restx.Model
- api.model 方法
parameters 字段

Parameters: default – The default value for the field, if no value is specified. attribute – If the public facing value differs from the internal value, use this to retrieve a different attribute from the response than the publicly named value. title (str) – The field title (for documentation purpose) description (str) – The field description (for documentation purpose) required (bool) – Is the field required ? readonly (bool) – Is the field read only ? (for documentation purpose) example – An optional data example (for documentation purpose) mask (callable) – An optional mask function to be applied to output

Apidocjs

Mon, 08 Mar 2021 00:00:00 +0000

教程

快速了解
- https://blog.jscrambler.com/documenting-apis-using-apidoc-js/
参考
- https://apidocjs.com/#param-api-error

`@apiIgnore` 跳过在写的部份（未完成）

`@apiSuccess` 返回 Response 参数解释

嵌套 json 解释

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


def crop_image():
 """
 @api {post} /crop_image Request to crop image for a pdf
 @apiName CropImagePost
 @apiGroup Cropper
 @apiVersion 0.1.0
 @apiSuccess {String} code Status code.
 @apiSuccess {Object[]} data Tasks' result list.

 @apiSuccess {Number} data.code Status code of the Task.
 @apiSuccess {String} data.coordinates Coordinate group of the Task.

 @apiSuccessExample {json} Success Response json:
 {
 "code": 2000,
 "data": [
 {
 "code": 2000,
 "coordinates": "1,166.6,539.87,16.5022,9.1575;1,166.6,539.87,16.5022,9.1575",
 }
 ],
 }

 """
 pass

一个函数多个 method

注意

Swagger on Sawyer Zheng's Blog

flask-restx notes

教程

namespace

Model

Apidocjs

教程

@apiIgnore 跳过在写的部份（未完成）

@apiSuccess 返回 Response 参数解释

一个函数 多个 method

`@apiIgnore` 跳过在写的部份（未完成）

`@apiSuccess` 返回 Response 参数解释

一个函数多个 method