以下关于REST软件架构设计理念和准则的描述

Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。以下是界面：

能够直接调试某一个接口，但是接口搜索功能有问题，如果能支持中文注释的检索更好

1、maven引入jar包

<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger2</artifactId>
		    <version>2.2.2</version>
		</dependency>
		<dependency>
		    <groupId>io.springfox</groupId>
		    <artifactId>springfox-swagger-ui</artifactId>
		    <version>2.2.2</version>
		</dependency>

2、增加配置文件

配置文件中，可以修改文档的一些说明，比如是什么模块的文档，文档描述，提供方等等

package com.ywsdService_DA;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;



/**
 * Swagger2配置类
 * 在与spring boot集成时，放在与Application.java同级的目录下。
 * 通过@Configuration注解，让Spring来加载该类配置。
 * 再通过@EnableSwagger2注解来启用Swagger2。
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
	 /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     * 
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.muyunfei"))
                .paths(PathSelectors.any())
                .build();
    }
    
    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("档案服务RESTful APIs")
                .description("本接口服务由*提供")
                .termsOfServiceUrl("http://www.muyunfei.com")
                .contact("牟云飞")
                .version("1.0")
                .build();
    }

}

有网友说需要跟启动文件XXXXapplication.java放在一起，测试不需要啊

注意修改config中的注解搜索目录

RequestHandlerSelectors.basePackage("com.muyunfei")

3、使用，给我们的Rest Api增加接口说明

    /**
     * swagger 常用注解说明
     * 
     * @Api：用在类上，说明该类的作用。
     * @ApiOperation：注解来给API增加方法说明。
     * @ApiImplicitParams : 用在方法上包含一组参数说明
     * @ApiImplicitParam：用来注解来给方法入参增加说明。
     * @ApiResponses：用于表示一组响应
     * @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
     * @ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
     * @ApiModelProperty：描述一个model的属性。
     * 
     * paramType说明：
     *      header：请求参数放置于Request Header，使用@RequestHeader获取
     *      query：请求参数放置于请求地址，使用@RequestParam获取
     *      path：（用于restful接口）-->请求参数的获取：@PathVariable
     *      body：（不常用）
     *      form（不常用）
     */

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import com.muyunfei.service.interf.IDemoService;

@Controller
@ResponseBody
@RequestMapping("/demoServ")
@Api(value = "DemoServ-微服务后台示例以及测试服务")
public class DemoServ {
	
	/**
	 * swagger 说明
	 * 
	 * @Api：用在类上，说明该类的作用。
	 * @ApiOperation：注解来给API增加方法说明。
	 * @ApiImplicitParams : 用在方法上包含一组参数说明
	 * @ApiImplicitParam：用来注解来给方法入参增加说明。
	 * @ApiResponses：用于表示一组响应
	 * @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
	 * @ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
	 * 
	 * paramType：
	 *      header：请求参数放置于Request Header，使用@RequestHeader获取
	 *      query：请求参数放置于请求地址，使用@RequestParam获取
	 *      path：（用于restful接口）-->请求参数的获取：@PathVariable
	 *      body：（不常用）
	 *      form（不常用）
	 */
	
	

	@Autowired
	private IDemoService demoServiceImpl;



	public IDemoService getDemoServiceImpl() {
		return demoServiceImpl;
	}

	public void setDemoServiceImpl(IDemoService demoServiceImpl) {
		this.demoServiceImpl = demoServiceImpl;
	}

	//无参数
	@ApiOperation(value="测试服务", notes="可以用来测试后台服务是否发布成功")
	@RequestMapping(value="retrieveHellWorld",method = RequestMethod.GET)
	public String retrieve(){
		return "HelloWorld";
	}
	

	//有普通参数,http://localhost:8881/ywsdService_DA/demoServ/testByParam_Normal?userName=111&userPwd=muyunfei
	@RequestMapping(value="testByParam_Normal",method = RequestMethod.GET)
	@ApiOperation(value="有参数的服务调用示例", notes="备注信息")
	@ApiImplicitParams({
		@ApiImplicitParam(paramType="query", name = "userName", value = "姓名", required = true, dataType = "Long"),
		@ApiImplicitParam(paramType="query", name = "userPwd", value = "密码", required = true, dataType = "String")
	})
	public String testByParam_Normal(@RequestParam("userName") long name,@RequestParam("userPwd")String pwd){
		
		return demoServiceImpl.HelloWord( name, pwd);
	}
	
	
}