用户注册



邮箱:

密码:

用户登录


邮箱:

密码:
记住登录一个月忘记密码?

发表随想


还能输入:200字

fresh    -  云代码空间

——

springboot微服务多用户商城系统java_代码开源_B2B电商系统_B2C电商系统(十一)s

2019-01-09|503阅||

摘要:springboot微服务多用户商城系统java_代码开源_B2B电商系统_B2C电商系统(十一)springboot集成swagger2,构建优雅的Restful API

swagger,中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅帅气,正如它的名字。

一、引入依赖

复制代码
    <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构建api文档")
                .description("简单优雅的restfun风格,http://blog.csdn.net/forezp")
                .termsOfServiceUrl("http://blog.csdn.net/forezp")
                .version("1.0")
                .build();
    }
}
复制代码

通过@Configuration注解,表明它是一个配置类,@EnableSwagger2开启swagger2。apiINfo()配置一些基本的信息。apis()指定扫描的包会生成文档。

三、写生产文档的注解

swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。

  • @Api:修饰整个类,描述Controller的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiProperty:用对象接收参数时,描述对象的一个字段
  • @ApiResponse:HTTP响应其中1个描述
  • @ApiResponses:HTTP响应整体描述
  • @ApiIgnore:使用该注解忽略这个API
  • @ApiError :发生错误返回的信息
  • @ApiParamImplicitL:一个请求参数
  • @ApiParamsImplicit 多个请求参数

现在通过一个栗子来说明:

复制代码
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.*; /** * 用户创建某本图书 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="创建图书", notes="创建图书")
    @ApiImplicitParam(name = "book", value = "图书详细实体", required = true, dataType = "Book")
    @RequestMapping(value="", method=RequestMethod.POST) public String postBook(@RequestBody Book book) {
        books.put(book.getId(), book); return "success";
    }
    @ApiOperation(value="获图书细信息", notes="根据url的id来获取详细信息")
    @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="根据url的id来指定更新图书信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "图书ID", required = true, dataType = "Long",paramType = "path"),
            @ApiImplicitParam(name = "book", value = "图书实体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="根据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!";
    }
}
复制代码

通过相关注解,就可以让swagger2生成相应的文档。如果你不需要某接口生成文档,只需要在加@ApiIgnore注解即可。需要说明的是,如果请求参数在url上,@ApiImplicitParam 上加paramType = “path” 。

资料和源码来源地址

Spring Cloud大型企业分布式微服务云构建的B2B2C电子商务平台源码请加企鹅求求: yuncode.net

顶 0踩 0收藏
文章评论
    发表评论

    个人资料

    • 昵称: fresh
    • 等级: 高级设计师
    • 积分: 5300
    • 代码: 0 个
    • 文章: 221 篇
    • 随想: 0 条
    • 访问: 3 次
    • 关注

    人气代码

      标签

      java(76)api(3)教程(25)Spring(41)cache(1)+(3)springmvc(2)mybatis(4)(十)(1)(十一)(1)Cloud(31)Boot(10)源码(7)简介(1)-(29)项目构建过程(3)关于Spring(2)Cloud的核心特性(1)整合spring(8)cloud云服务架构(9)cloud架构(1)HongHu(1)Cloud云架构(10)登出流程(3)(1)Spring+(1)Commons(1)普通抽象(1)项目过程构建(3)commonserv(1)common-ser(1)commonserv(1)SSO单点登录应用认(1)Cloud分布式微服(1)(1)Eureka(1)云架构代码结构构建(3)分享Spring(3)Cloud大型互联网(1)common-ser(1)SpringClou(1)Cloud--Hon(1)Cloud分布式微服(1)springclou(1)Eureka服务器搭(1)SSO单点登录之OA(1)SSO单点登录之OA(1)Cloud-hong(1)Cloud分布式微服(1)Cloud微服务分布(1)Cloud分布式微服(1)Config客户端使(1)Cloud微服务架构(1)Config环境库(2)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)根据token获取用(1)commonserv(1)Cloud微服务分布(1)mybatis分布式(1)mybatis分布式(1)mybatis分布式(1)4.2.2以上版本和(1)mybatis分布式(1)mybatis分布式(1)Cloud引导应用程(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud大型互联网(1)Cloud-hong(1)Cloud分布式微服(1)SpringBoot(81)common-ser(1)Cloud分布式微服(1)Cloud企业微服务(1)Cloud自定义引导(1)企业级(26)(一)(1)(二)(1)(三)(1)cloud项目(2)(五)(1)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)(十二)(1)SSO单点登录之OA(1)B2B2C(64)关于SpringCl(1)Cloud构建分布式(1)SpringClou(1)mybatis电子商(1)(九)Java(2)o2o多用户商城(21)(十)Java(1)(十三)java(3)b2b2c多用户商城(6)(十四)Java(2)(十五)Java(1)(十六)Java(1)b2b2c多用户商城(1)SSO单点登录之OA(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)(十七)Java(1)springclou(1)springclou(1)springclou(1)springclou(1)B2B2C多租户电子(1)SpringClou(1)SpringClou(1)项目构建过程(七)(1)(八)Java(1)Config)(8)ssm(17)企业级java(14)shop(22)springclou(1)多用户商城系统源码((1)springclou(1)多用户商城系统源码(9)(十二)java(2)多用户商城系统源码-(3)Sleuth)(2)Springclou(1)分布式、微服务、云架(1)多用户商城系统源码((1)springclou(1)B2B2C多租户电子(1)springclou(1)(三):服务提供与调(1)SpringClou(1)springclou(1)企业云架构commo(1)springclou(1)common-ser(1)springclou(1)commonserv(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)(十一)JAVA(1)b2b2c多用户商城(1)b2b2c多用户商城(1)SSO单点登录之OA(1)springclou(1)springclou(1)配置自动刷新(1)beatlsql(1)多用户商城系统(2)(八)springb(1)多用户商城系统源码((1)b2bc商城系统开源(1)(十)用spring(2)Restdocs创建(1)springboot(1)springboot(1)微服务java_b2(1)(十三)spring(1)springboot(1)(十四)在sprin(1)springclou(1)(二)Spring(3)Boot配置文件详解(5)整合JPA(3)企业分布式微服务云S(1)(五)路由网关(zu(1)b2bc商城系统开源(1)springboot(1)springclou(1)b2b2c多用户商城(1)springclou(1)(九)服务链路追踪((1)b2bc商城系统开源(1)b2b2c多用户商城(1)b2bc商城系统开源(1)Dashboard)(1)springclou(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码((1)微服务java_b2(1)b2b2c多用户商城(1)SSO单点登录之OA(1)Springboot(1)Springclou(1)多级分销Spring(1)多级分销Spring(1)(二)java(1)springboot(1)springclou(1)(五)JAVA(1)b2b2c多用户商城(1)Dashboard和(1)(六)企业分布式微服(1)分布式配置中心(Sp(1)(六)(1)Java多用户商城系(1)Java版本多用户B(1)B2B2C源码电子商(1)-(五)路由网关(z(1)Springclou(1)Springboot(1)mybatis电子商(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码((1)多用户商城系统(三)(1)SpringBoot(1)高可用的分布式配置中(1)微服务java_b2(1)springclou(1)b2b2c多用户商城(1)springboot(1)b2b2c多用户商城(1)springclou(1)springboot(1)b2b2c多用户商城(1)b2bc商城系统开源(1)(九)服务链路追踪((1)SpringBoot(1)多用户商城系统(八)(1)Springboot(1)springclou(1)springclou(1)多级分销Spring(1)多级分销Spring(1)(十一)docker(1)b2bc商城系统开源(1)springclou(1)b2b2c多用户商城(1)多级分销Spring(1)整合企业架构的技术点(1)springclou(1)springclou(1)b2b2c多用户商城(1)springclou(1)b2b2c多用户商城(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)b2b2c多用户商城(1)springclou(1)b2bc商城系统开源(1)springclou(1)b2b2c多用户商城(1)b2bc商城系统开源(1)b2b2c多用户商城(1)springclou(1)b2bc商城系统开源(1)(四)SpringB(1)多用户商城系统源码((1)微服务java_b2(1)(十)高可用的服务注(1)企业分布式微服务云S(1)(十一)docker(1)多用户商城系统-(七(1)springclou(1)Springclou(1)Springclou(1)b2bc商城系统开源(1)多用户商城系统源码-(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多用户商城系统源码-(1)多用户商城系统-(九(1)多用户商城系统源码-(1)springboot(1)b2b2c多用户商城(1)b2b2c多用户商城(1)多用户商城系统源码((1)(九)springb(1)b2bc商城系统开源(1)教程(十五)Spri(1)(十六)用restT(1)企业SpringBo(1)教程(五)sprin(1)企业(1)教程(六)sprin(1)企业分布式微服务云S(1)(一)服务的注册与发(1)(十六)用restT(1)Cloud微服务架构(1)(六)整合sprin(1)企业云架构commo(1)(七)整合sprin(1)common-ser(1)(八)整合sprin(1)commonserv(1)(十四)在sprin(1)(十五)Spring(1)(十六)用restT(1)(十七)上传文件(1)(十八)定时任务(S(1)Tasks)(1)(十九)(1)验证表单信息(1)(二十)处理表单提交(1)SpringClou(1)服务的注册与发现(E(1)SpringClou(1)服务消费者(rest(1)SpringClou(1)服务消费者(Feig(1)SpringClou(1)(四)(1)断路器(Hystri(1)SpringClou(1)(五)路由网关(zu(1)SpringClou(1)(七)(3)高可用的分布式配置中(1)SpringClou(1)高可用的分布式配置中(1)(一)微服务分布式云(1)(二)微服务分布式云(1)cloud整合企业架(1)(三)微服务分布式云(1)cloud集成项目简(1)(四)微服务分布式云(1)企业分布式微服务云架(1)(五)微服务分布式云(1)(五)微服务分布式云(1)SpringClou(1)分布式配置中心(Sp(1)SpringClou(1)高可用的分布式配置中(1)(一)构建第一个Sp(1)(三)SpringB(1)(四)SpringB(1)(九)springb(1)Restdocs创建(1)

      最新提问

        站长推荐