Swagger4 深入了解一下

Posted 2021-02-13 itmeatball

4.1私人定制（根据数据的type来对数据进行限制）

4.1.1字符串长度和格式

当定义一个字符串属性时，我们可以定制它的长度和格式

eg 

   username:

            type:string

            pattern:"[a-z0-9]{8,64}"   #用正则表达式定义字符串的格式

            minLength:8     #字符串最小长度

            maxLength:64  #字符串最大长度

4.2高级数据定义

4.2.1读写操作同一定义的数据

有时候我们读取资源信息的内容会比我们写入资源信息的内容更多，这样是不是意味着我们必须专门为读取资源和写入资源分别定义不同的数据模型呢？

OpenAPI规范中readOnly字段可以帮助我们解决这个问题

eg.lastTimeOnline:                                          #在这里lastTimeOnline属性值为true意味着当我们创建一个用户时不需要把这个属性值post到服务器，因此在创建这个用户时不需要为这个属性赋值

           type:string

           format:dateTime

           readOnly:true

4.2.2组合定义确保一致性

当我们在获取一组用户信息时，需要同时获取页面信息，而且这些页面信息必须在根节点上，把这几个属性抽取出来，建立一个paging模型，实现一处定义，处处使用

但是页面属性不再位于根节点时该怎么破？

eg.

   PagedPersons:

     allOf:                                                      #这个例子表示，PagedPersons根节点下，具有将Persons和Paging展开后的全部属性。

         - $ref:"#/definitions/Persons"

         -$ref:"#definitions/Paging"