用户注册



邮箱:

密码:

用户登录


邮箱:

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

发表随想


还能输入:200字

cloud云    -  云代码空间

——

(十一)java B2B2C Springboot多租户电子商城系统-springboot集成swa

2019-01-30|36阅||

摘要:(十一)java B2B2C Springboot多租户电子商城系统-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!";
    }
}

 

SpringCloud大型企业分布式微服务云构建的B2B2C电子商务平台源码请加企鹅求求:一零三八七七四六二六

顶 0踩 0收藏
分享到:
更多
文章评论
    发表评论

    个人资料

    • 昵称: cloud云
    • 等级: 中级设计师
    • 积分: 4570
    • 代码: 0 个
    • 文章: 163 篇
    • 随想: 0 条
    • 访问: 9 次
    • 关注

    人气代码

      标签

      java(56)api(1)Spring(50)cache(1)+(8)springmvc(3)(十)(2)(十一)(2)Cloud(22)Cloud-hong(1)Cloud分布式微服(1)Cloud-Hong(1)Cloud分布式微服(1)Cloud-鸿鹄Cl(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--Hon(1)Cloud分布式微服(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)企业分布式微服务云架(1)Cloud-Hong(1)Cloud分布式微服(1)Boot(2)企业分布式微服务云架(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)Cloud--Hon(1)Cloud分布式微服(1)企业分布式微服务云架(1)Cloud--hon(1)Cloud分布式微服(1)Cloud--Hon(1)分布式微服务云系统-(1)cloud--鸿鹄C(1)源码(12)-(19)cloud集成项目(1)Cloud云服务(1)整合spring(11)cloud云服务架构(3)介绍一下Spring(1)Cloud微服务架构(1)总结Spring(1)Cloud云架构(12)登出流程(3)(1)Cloud+Spri(1)Boot+Mybat(1)+微服务(1)企业分布式微服务云架(1)Spring+(1)SSO单点登录应用认(1)跟大家介绍一下关于S(1)Consul(1)Cloud构建微服务(1)Cloud构建微服务(1)Cloud构建微服务(1)SSO单点登录之OA(1)根据token获取用(1)Netflix(2)springclou(1)RestTempla(1)HongHu云架构c(1)Commons(1)普通抽象(1)Config-Git(1)Cloud--Hon(1)分布式微服务云系统-(1)Cloud微服务分布(1)企业分布式微服务云架(1)Cloud自定义引导(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)cloud云架构-S(1)企业分布式微服务云架(1)企业分布式微服务云架(1)Cloud--Hon(1)Cloud分布式微服(1)分享Spring(1)Cloud微服务架构(1)Cloud微服务分布(1)Cloud-hong(1)Cloud分布式微服(1)springclou(1)Cloud微服务分布(1)SpringBoot(32)Cloud各个组件配(1)RestTempla(1)Cloud分布式微服(1)Cloud自定义引导(1)Cloud构建微服务(1)Cloud构建微服务(1)(十七)(1)-消息驱动(1)cloud项目(1)(十二)(2)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)(九)整合sprin(1)commonserv(1)SSO单点登录之OA(1)SSO单点登录之OA(1)SSO单点登录之OA(1)(十三)(1)SSO单点登录之OA(1)B2B2C(53)(九)Java(1)o2o多用户商城(24)(十)Java(1)(十一)Java(2)(十二)(1)springclou(1)springclou(1)springclou(1)SSO单点登录之OA(1)springclou(1)SSO单点登录之OA(1)springclou(1)(十三)java(2)b2b2c多用户商城(6)(十四)Java(1)(十五)Java(2)(十六)Java(2)b2b2c多用户商城(1)SSO单点登录之OA(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)springclou(1)(十七)Java(1)springclou(1)springclou(1)项目构建过程(七)(2)mybatis电子商(1)Springclou(1)Cloud构建分布式(1)SpringClou(1)Config)(1)ssm(15)springclou(1)b2b2c多用户商城(1)B2B2C多租户电子(1)springclou(1)springclou(1)springclou(1)springclou(1)企业级java(5)shop(6)多用户商城系统源码(2)(十二)java(1)关于SpringCl(1)Bus)(1)b2bc商城系统开源(1)Sleuth)(1)多用户商城系统源码-(1)微服务java_b2(1)springclou(1)springclou(1)springclou(1)springclou(1)b2bc商城系统开源(1)配置自动刷新(1)(四):(1)b2b2c多用户商城(1)Dashboard和(1)b2b2c多用户商城(1)b2b2c多用户商城(1)多用户商城系统(1)springboot(1)(十三)spring(1)微服务java_b2(1)(十二)spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)b2b2c多用户商城(1)(二)Spring(2)Boot配置文件详解(1)springclou(1)(一)构建第一个Sp(1)多用户商城系统(三)(1)微服务java_b2(1)整合JPA(1)springclou(1)多级分销Spring(1)多级分销spring(1)mybatis多租户(1)多级分销spring(1)mybatis多租户(1)mybatis多租户(1)多级分销Spring(1)cloud微服务分布(1)Cloud集成项目简(1)cloud微服务分布(1)整合企业架构的技术点(1)(十三)java(1)(五)JAVA(1)多用户商城系统源码:(1)b2b2c多用户商城(1)springclou(1)(十二)Spring(1)多用户商城系统:使用(1)Sleuth和Zip(1)(十)java(2)多用户商城系统源码:(1)(十一)企业级jav(1)b2bc商城系统开源(1)(八)java(1)(九)Java(1)多级分销spring(1)mybatis多租户(1)springclou(1)springclou(1)b2b2c多用户商城(1)(十二)微服务多用户(1)springclou(1)Springclou(1)分布式环境下自动发现(1)springclou(1)springclou(1)b2b2c多用户商城(1)b2bc商城系统开源(1)多级分销Spring(1)Dashboard和(1)多级分销Spring(1)多级分销spring(1)mybatis多租户(1)springclou(1)(十一)Java(1)springclou(1)b2bc商城系统开源(1)springclou(1)b2b2c多用户商城(1)多用户商城系统源码((1)springboot(1)Java多用户商城系(1)多用户商城系统(一)(1)springclou(1)Springboot(1)springclou(1)b2b2c多用户商城(1)b2b2c多用户商城(1)springboot(1)(十四)(1)多级Springbo(1)Springboot(1)b2b2c多用户商城(1)springclou(1)springclou(1)springclou(1)springclou(1)common-ser(1)b2b2c多用户商城(1)b2b2c多用户商城(1)企业云架构commo(1)b2bc商城系统开源(1)common-ser(1)微服务java_b2(1)多租户电子商城系统(1)b2b2c多用户商城(1)多级分销Spring(1)整合企业架构的技术点(1)springboot(1)企业云架构commo(1)

      最新提问

        站长推荐