本文詳細闡述了knn演算法，從開始介紹什麼事knn，到講解knn演算法的原理再到最後以實際例子來運用knn演算法的步驟，實際例子的代碼講解也十分詳細 ...
一、Swagger2介紹
前後端分離開發模式中，api文檔是最好的溝通方式。
Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。
- 及時性 (介面變更後，能夠及時準確地通知相關前後端開發人員)
- 規範性 (並且保證介面的規範性，如介面的地址，請求方式，參數及響應格式和錯誤信息)
- 一致性 (介面信息一致，不會出現因開發人員拿到的文檔版本不一致，而出現分歧)
- 可測性 (直接在介面文檔上進行測試，以方便理解業務)
二、配置Swagger2
1、引入相關依賴
<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
2、創建swagger的配置類
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("XX平臺API文檔")
.description("本文檔描述了xxx介面定義")
.version("1.0")
// 創建人
.contact(new Contact("Jade", "http://jade.com", "[email protected]"))
.build();
}
}
3、在啟動類上添加註解掃描swagger的配置類，進行測試
要能掃描到swagger的配置類SwaggerConfig
@SpringBootApplication
// 要能掃描到swagger的配置類SwaggerConfig
@ComponentScan(basePackages = {"com.jade"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
4、API模型
可以添加一些自定義設置，例如：
定義樣例數據
@ApiModelProperty(value = "創建時間", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@ApiModelProperty(value = "更新時間", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;
5、定義介面說明和參數說明
定義在類上：@Api
定義在方法上：@ApiOperation
定義在參數上：@ApiParam
@Api(description="講師管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {
@Autowired
private TeacherService teacherService;
@ApiOperation(value = "所有講師列表")
@GetMapping
public List<Teacher> list(){
return teacherService.list(null);
}
@ApiOperation(value = "根據ID刪除講師")
@DeleteMapping("{id}")
public boolean removeById(
@ApiParam(name = "id", value = "講師ID", required = true)
@PathVariable String id){
return teacherService.removeById(id);
}
}
6、測試，查看效果
訪問http://localhost:8080/swagger-ui.html 即可
