Swagger學習筆記（2020 11 17）

1.建立乙個spring boot -web專案

2.匯入相關依賴

io.springfox

springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2

4.配置swagger->config

@configuration

@enableswagger2 //開啟swagger2
public class swaggerconfig 

swagger的bean例項docket；

//配置swagger的docket的bean例項

@bean
public docket docket()
//配置swagger資訊 apiinfo
public apiinfo apiinfo()

docket.select()

public docket docket()

//配置swagger的docket的bean例項

@bean
public docket docket()

//設定要顯示的swagger環境

profiles profiles = profiles.of("dev","test");
//通過environment.acceptsprofiles判斷是否處在自己設定的環境當中
boolean flag = environment.acceptsprofiles(profiles);
new docket.enable(flag)

.groupname("程菜雞")

解：多個dockct例項即可

@bean

public docket docket1()
@bean
public docket docket2()
@bean
public docket docket3()

//@api(注釋 )

@apimodel("使用者實體類")
public class user 
public void setusername(string username) 
public string getpassword() 
public void setpassword(string password) 
}

package com.cheng.controller;

import com.cheng.controller.pojo.user;
import io.swagger.annotations.api;
import io.swagger.annotations.apioperation;
import io.swagger.annotations.apiparam;
import org.springframework.web.bind.annotation.restcontroller;
/** * @描述
* @建立時間 2020/11/16
*/@restcontroller
public class hellocontroller 
//只要我們的介面中返回值存在實體類，他就會被掃瞄到swagger
public user user()
@apioperation("hello2方法")
public string hello2(@apiparam("使用者名稱") string username)
@apioperation("psot測試方法")
public user postt(@apiparam("使用者名稱") user user)
}

2.介面文件實時更新

swagger是乙個優秀的工具，幾乎所有公司都在用它

出於安全考慮和節省記憶體，在發布專案的時候要關閉swagger！！！

Swagger筆記 Swagger3配置

swagger是一組圍繞openapi規範構建的開源工具，可幫助您設計 構建 記錄和使用rest api。主要的swagger工具包括 swagger editor 基於瀏覽器的編輯器，您可以在其中編寫openapi規範。swagger ui 將openapi規範呈現為互動式api文件。swagge...

Swagger基礎學習

api框架 restful文件自動生成工具，api文件與定義的同步更新 使用兩個庫 io.springfoxgroupid springfox swagger uiartifactid 2.10.5version dependency io.springfoxgroupid springfox sw...

swagger使用 筆記

引入依賴 io.springfoxgroupid springfox swagger uiartifactid 2.9.2version dependency io.springfoxgroupid springfox swagger2artifactid 2.9.2version dependen...