Knife4jPDFAPI框架

ate ApiInfo apiInfo() { return new ApiInfoBuilder() .title(title) .description(description) .termsOfServiceUrl(termsOfServiceUrl) .contact(new Contact(contactName, contactUrl, contactEmail)) .version(version) .build();}}

【留意】必须修订以上固定式里面的工具箱名，保证是局限性计划里面转换器类所在的工具箱！其它各项均可不修订，以上固定式文件可以从Knife4j的官网找到！

最后，还需在元样本里面触发Knife4j的弱化Mode：

knife4j: #是否触发弱化Mode enable: true

完成后，启动计划，在浏览器里面采访 即可核对局限性计划的API文件。

在转换器类上附加于大@Api于大注释，并固定式于大tags于大物件，可以均须可选旧名，例如：

@Api(tags = "政府机构员政府机构可选") // 升级@RestController@RequestMapping(value = "/admins", produces = "application/JSON; charset=utf-8")public class AdminController { // ===== 原来其它文件 =====}

在管控立即的原理上附加于大@ApiOperation于大注释可以固定式该公司旧名，例如：

@ApiOperation("政府机构员写明") // 升级@PostMapping("/login")public JsonResult login(@Validated AdminLoginDTO adminLoginDTO) { AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO); return JsonResult.ok(adminSimpleVO);}

当需均须各该公司在API文件里面的辨识左至右时，可以在管控立即的原理上附加于大@ApiOperationSupport于大注释，固定式此注释的于大order于大物件，最终在辨识API文件时，会根据于大order于大物件绝对值升序排列，例如：

@ApiOperation("政府机构员写明")@ApiOperationSupport(order = 900) // 升级@PostMapping("/login")public JsonResult login(@Validated AdminLoginDTO adminLoginDTO) { AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO); return JsonResult.ok(adminSimpleVO);}

【不一定】建议以上固定式的于大order于大绝对值大概是2位的十六进制，并且有预留所在位置，例如10~19相互间的都是增加样本的该公司，20~29相互间的都是删去样本的该公司，30~39相互间都是修订样本的该公司，40~49相互间都是查询样本的该公司。

如果转换器管控立即的原理的变量是快捷键的烧录子类，可以在烧录子类的物件上附加于大@ApiModelProperty于大来固定式变量在文件里面的辨识，例如：

import io.swagger.annotations.ApiModelProperty;import lombok.Data;import javax.validation.constraints.NotNull;import java.io.Serializable;@Datapublic class AdminLoginDTO implements Serializable { @ApiModelProperty(value = "用户名") // 固定式变量名 private String username; @ApiModelProperty("加密") // 固定式变量名 private String password;}

以上于大@ApiModelProperty于大除了可以固定式变量在API文件里面辨识的旧名以外，还可以固定式是否必须，例如：

@ApiModelProperty(value = "用户名", required = true)

另外，还可以固定式变量子类等，但是，并不是必须固定式，不一定开放性可以情况下自动识别。

对于部分旧名意味著相比较一般来说（一般人直接如出一辙）的物件，或者对绝对值的一般性拒绝相比较明确（例如某些取绝对值为0或1）的物件，可以参见示例，使得核对API文件的人可以参考，例如：

@ApiModelProperty(value = "用户名", required = true, example = "admin")

除以固定式立即变量以外，此物件还可以可用叛离结果的子类，例如：

public class JsonResult implements Serializable { @ApiModelProperty("该公司状态码") private Integer state; @ApiModelProperty("消息") private String message; @ApiModelProperty("样本") private T data; // ......}

如果以上于大private T data;于大的实际绝对值也需附加说明，则在完全一致的类的物件上继续使可用大@ApiModelProperty于大固定式即可！需留意：此处于大data于大物件可以是任意样本子类，必须声明为泛型，不可以是于大Object于大，否则将难以应可用大@ApiModelProperty于大的固定式。

另外，当附加在叛离的子类的物件上时，还可以在于大@ApiModelProperty于大注释里面固定式于大position于大物件，可用另设各物件在叛离的JSON里面的辨识左至右，例如：

@ApiModelProperty(value = "该公司状态码", position = 5)

学习记录，如有著作权请联络删去

。

昆明妇科医院哪家专业
贵阳癫痫治疗医院
广东妇科医院哪好
贵阳癫痫治疗方法有什么
驻马店看白癜风去哪家医院比较好
颧骨整形
阴囊湿疹
感染者又增加？新冠的三大知识点一定要知道！
太极急支糖浆适用于哪种咳嗽
阳了吃什么药好得快