spring cloud b2b2c電子商務(wù)社交平臺源碼請加企鵝求求：叁五叁六貳四柒貳五九棒搜。swagger,中文“拽”的意思疹蛉。它是一個功能強(qiáng)大的api框架，它的集成非常簡單力麸，不僅提供了在線文檔的查閱可款，而且還提供了在線文檔的測試。另外swagger很容易構(gòu)建restful風(fēng)格的api克蚂，簡單優(yōu)雅帥氣闺鲸，正如它的名字。
一埃叭、引入依賴
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
二摸恍、寫配置類
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.forezp.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利用swagger構(gòu)建api文檔")
.description("簡單優(yōu)雅的restfun風(fēng)格，http://blog.csdn.net/forezp")
.termsOfServiceUrl("http://blog.csdn.net/forezp")
.version("1.0")
.build();
}
}
通過@Configuration注解游盲，表明它是一個配置類，@EnableSwagger2開啟swagger2蛮粮。apiINfo()配置一些基本的信息益缎。apis()指定掃描的包會生成文檔。
三然想、寫生產(chǎn)文檔的注解
swagger通過注解表明該接口會生成文檔莺奔，包括接口名、請求方法变泄、參數(shù)令哟、返回信息的等等。
@Api：修飾整個類妨蛹，描述Controller的作用
@ApiOperation：描述一個類的一個方法屏富，或者說一個接口
@ApiParam：單個參數(shù)描述
@ApiModel：用對象來接收參數(shù)
@ApiProperty：用對象接收參數(shù)時，描述對象的一個字段
@ApiResponse：HTTP響應(yīng)其中1個描述
@ApiResponses：HTTP響應(yīng)整體描述
@ApiIgnore：使用該注解忽略這個API
@ApiError ：發(fā)生錯誤返回的信息
@ApiParamImplicitL：一個請求參數(shù)
@ApiParamsImplicit 多個請求參數(shù)
現(xiàn)在通過一個栗子來說明：
package com.forezp.controller;
import com.forezp.entity.Book;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
import java.util.*;
/**
* 用戶創(chuàng)建某本圖書 POST /books/
* 用戶修改對某本圖書 PUT /books/:id/
* 用戶刪除對某本圖書 DELETE /books/:id/
* 用戶獲取所有的圖書 GET /books
* 用戶獲取某一圖書 GET /Books/:id
* Created by fangzhipeng on 2017/4/17.
* 官方文檔：http://swagger.io/docs/specification/api-host-and-base-path/
*/
@RestController
@RequestMapping(value = "/books")
public class BookContrller {
Map<Long, Book> books = Collections.synchronizedMap(new HashMap<Long, Book>());
@ApiOperation(value="獲取圖書列表", notes="獲取圖書列表")
@RequestMapping(value={""}, method= RequestMethod.GET)
public List<Book> getBook() {
List<Book> book = new ArrayList<>(books.values());
return book;
}
@ApiOperation(value="創(chuàng)建圖書", notes="創(chuàng)建圖書")
@ApiImplicitParam(name = "book", value = "圖書詳細(xì)實(shí)體", required = true, dataType = "Book")
@RequestMapping(value="", method=RequestMethod.POST)
public String postBook(@RequestBody Book book) {
books.put(book.getId(), book);
return "success";
}
@ApiOperation(value="獲圖書細(xì)信息", notes="根據(jù)url的id來獲取詳細(xì)信息")
@ApiImplicitParam(name = "id", value = "ID", required = true, dataType = "Long",paramType = "path")
@RequestMapping(value="/{id}", method=RequestMethod.GET)
public Book getBook(@PathVariable Long id) {
return books.get(id);
}
@ApiOperation(value="更新信息", notes="根據(jù)url的id來指定更新圖書信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "圖書ID", required = true, dataType = "Long",paramType = "path"),
@ApiImplicitParam(name = "book", value = "圖書實(shí)體book", required = true, dataType = "Book")
})
@RequestMapping(value="/{id}", method= RequestMethod.PUT)
public String putUser(@PathVariable Long id, @RequestBody Book book) {
Book book1 = books.get(id);
book1.setName(book.getName());
book1.setPrice(book.getPrice());
books.put(id, book1);
return "success";
}
@ApiOperation(value="刪除圖書", notes="根據(jù)url的id來指定刪除圖書")
@ApiImplicitParam(name = "id", value = "圖書ID", required = true, dataType = "Long",paramType = "path")
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
public String deleteUser(@PathVariable Long id) {
books.remove(id);
return "success";
}
@ApiIgnore//使用該注解忽略這個API
@RequestMapping(value = "/hi", method = RequestMethod.GET)
public String jsonTest() {
return " hi you!";
}
}
通過相關(guān)注解蛙卤，就可以讓swagger2生成相應(yīng)的文檔狠半。如果你不需要某接口生成文檔，只需要在加@ApiIgnore注解即可颤难。需要說明的是神年，如果請求參數(shù)在url上，@ApiImplicitParam 上加paramType = “path” 行嗤。
spring cloud b2b2c電子商務(wù)社交平臺源碼請加企鵝求求：叁五叁六貳四柒貳五九
