葡京在线开户SpringBoot 使用Swagger2打造在线接口文档(附汉化教程)

PH快报是 Product X
项目下之一个传媒专栏,由同众产品爱好者自发编译来自Producthunt榜单上之产品,每日更新,期待而的关注同支持!

前言:编写和掩护接口文档是每个程序员的任务,根据Swagger2可以迅速救助我们编辑最新的API接口文档,再为不用担心开会前按照忙于整理各种资料了,间接提升了团组织开发之联系效率。此外,本学科还附加提供了UI汉化教程,去除阅读官方英文界面的闷。(目前Swagger汉化教程是摸索不交之,因为官方手册实在写得最好烂。。)

翻志愿者征集中,有趣味的童鞋请站外信我们,标题请注明
PH翻译志愿者,
期待您的入!对某产品感兴趣?点击产品名称即可进入,试用后有啊感想记告诉我们啊~~

SpringBoot + Swagger2 UI界面-汉化教程


1.默认的英文界面UI

或许很多青少年伴都曾经以过Swagger,但是打开UI界面之后,却是下边这样的画风,纯英文的界面并无绝对劲儿,作为国人还是习惯中文界面。

葡京在线开户 1

何谓世界太盛的API工具总不拖欠不支持国际化属性吧,楼主在官使用手册找到关于本地化和翻译的征:

葡京在线开户 2

也就是说,只要添加翻译器和于的译文JS就好来得中文界面了。(使用IDEA
双击Shift 快速找到swagger-ui.html 入口文件)

葡京在线开户 3

流淌:对静态资源的寄放路径有疑惑的请戳:SpringBoot项目组织说明

Mamba Out

  • 『Web;篮球』科比上DEAR
    BASKETBALL退役声明后,无数球迷吧的心碎,在NBA赛场达到同场竞技的球员等也毫无例外扼腕叹息。把NBA球员及针对性他爱恨交织的各球迷的感言收集起来,做成网站Mamba
    Out(曼巴不再),是<b> </b>Jad
    Limcaco这员铁杆球迷向科比致敬的绝佳方式。(译者:当您意识凯尔特人球迷在20年不衰的敌意之中不得不为此诗一般的语言对科比的passion,
    pride, and
    professionalism致以崇高的尊崇,而这种爱恨交织的情怀无法准确地翻为中文,你会庆幸没有当英文及白花时间)
Mamba Out.png

2.定制中文界面

[Kong]

(https://www.producthunt.com/r/6a38ef6d55b5bb/42979?app\_id=612)

  • 『web;
    电商』在线的电子商务建站平台。来自英国。提供的功能包括网店模板、购物车、产品管理、店面管理、SEO及网络营销、网店分析等。其极其骄傲之是他们之模板设计,因为他们自一家设计企业,所以本着好之审美较为自信。Kong
    的阳台完全免费。
Kong.png

2.1 添加首页和译文

重要来了,在resourece目录下开创\META-INF\resourece目录,然后创建一个称号也”swagger-ui.html”
的HTML文件。

葡京在线开户 4

注意文件名不要起错,接下将下面这段内容原封不动的正片进去。

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="icon" type="image/png" href="webjars/springfox-swagger-uivicon-32x32.png" sizes="32x32"/>
    <link rel="icon" type="image/png" href="webjars/springfox-swagger-uivicon-16x16.png" sizes="16x16"/>
    <link href='webjars/springfox-swagger-ui/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
    <link href='webjars/springfox-swagger-ui/css/print.css' media='print' rel='stylesheet' type='text/css'/>

    <script src='webjars/springfox-swagger-ui/lib/object-assign-pollyfill.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.slideto.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.wiggle.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/handlebars-4.0.5.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/lodash.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/backbone-min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/swagger-ui.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/jsoneditor.min.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/marked.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lib/swagger-oauth.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/springfox.js' type='text/javascript'></script>

    <!--国际化操作:选择中文版 -->
    <script src='webjars/springfox-swagger-ui/lang/translator.js' type='text/javascript'></script>
    <script src='webjars/springfox-swagger-ui/lang/zh-cn.js' type='text/javascript'></script>

</head>

<body class="swagger-section">
<div id='header'>
    <div class="swagger-ui-wrap">
        <a id="logo" href="http://swagger.io">![](webjars/springfox-swagger-uilogo_small.png)swagger</a>
        <form id='api_selector'>
            <div class='input'>
                <select id="select_baseUrl" name="select_baseUrl"></select>
            </div>
            <div class='input'><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"/></div>
            <div id='auth_container'></div>
            <div class='input'><a id="explore" class="header__btn" href="#" data-sw-translate>Explore</a></div>
        </form>
    </div>
</div>

<div id="message-bar" class="swagger-ui-wrap" data-sw-translate> </div>
<div id="swagger-ui-container" class="swagger-ui-wrap"></div>
</body>
</html>

OK 大功告成 我们访问
http://localhost:8080/swagger-ui.html
看看显示力量:

葡京在线开户 5

葡京在线开户 6

注:关于国际化,直接当Github下充斥好Swagger-UI的源码,将swagger-ui.html替换成上文,直接披露暨Maven私服仓库,使用效果又漂亮。

CATS Right Meow

  • 『节目;喵』苹果电视上喵星人专属频道,24钟头免停播的GIF动图。还有更多--你可管你下之猫咪拍照发推,爱特@CatsTVapp,它就是高达电视啦。
CATS Right Meow.png

2.2 更详实的译文翻译(非必需)

倘若想愈调译文,可以以META-INF\resources\webjars\springfox-swagger-ui\lang
目录下加加zh-cn.js文件.

葡京在线开户 7

下一场在译文(zh-cn.js )根据个人喜好来填补加翻译内容,如下

'use strict';

/* jshint quotmark: double */
window.SwaggerTranslator.learn({
    "Warning: Deprecated":"警告:已过时",
    "Implementation Notes":"实现备注",
    "Response Class":"响应类",
    "Status":"状态",
    "Parameters":"参数",
    "Parameter":"参数",
    "Value":"值",
    "Description":"描述",
    "Parameter Type":"参数类型",
    "Data Type":"数据类型",
    "Response Messages":"响应消息",
    "HTTP Status Code":"HTTP状态码",
    "Reason":"原因",
    "Response Model":"响应模型",
    "Request URL":"请求URL",
    "Response Body":"响应体",
    "Response Code":"响应码",
    "Response Headers":"响应头",
    "Hide Response":"隐藏响应",
    "Headers":"头",
    "Try it out!":"试一下!",
    "Show/Hide":"显示/隐藏",
    "List Operations":"显示操作",
    "Expand Operations":"展开操作",
    "Raw":"原始",
    "can't parse JSON.  Raw result":"无法解析JSON. 原始结果",
    "Example Value":"示例",
    "Click to set as parameter value":"点击设置参数",
    "Model Schema":"模型架构",
    "Model":"模型",
    "apply":"应用",
    "Username":"用户名",
    "Password":"密码",
    "Terms of service":"服务条款",
    "Created by":"创建者",
    "See more at":"查看更多:",
    "Contact the developer":"联系开发者",
    "api version":"api版本",
    "Response Content Type":"响应Content Type",
    "Parameter content type:":"参数类型:",
    "fetching resource":"正在获取资源",
    "fetching resource list":"正在获取资源列表",
    "Explore":"浏览",
    "Show Swagger Petstore Example Apis":"显示 Swagger Petstore 示例 Apis",
    "Can't read from server.  It may not have the appropriate access-control-origin settings.":"无法从服务器读取。可能没有正确设置access-control-origin。",
    "Please specify the protocol for":"请指定协议:",
    "Can't read swagger JSON from":"无法读取swagger JSON于",
    "Finished Loading Resource Information. Rendering Swagger UI":"已加载资源信息。正在渲染Swagger UI",
    "Unable to read api":"无法读取api",
    "from path":"从路径",
    "server returned":"服务器返回"
});

===========接下来,正式上Swagger2的动教程===========

Microsoft FindTime

  • 『全平台;Outlook插件』利用投票机制,解决预约开会时间的郁闷。
Microsoft FindTime.png

SpringBoot + Swagger2 使用教程

Artsxdesign Tab

  • 『艺术品推荐;chrome插件』每次打开chrome新页面会为您轻易推荐一副艺术作品,适合文艺控,作品偏现代。
Artsxdesign Tab.png

1. 引入依赖

    <!--依赖管理 -->
    <dependencies>
        <dependency> <!--添加Web依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency><!--添加Swagger依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency><!--添加Swagger-UI依赖 -->
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency> <!--添加热部署依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
        <dependency><!--添加Test依赖 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

Get Cartman

  • 『Slack机器人;征集反馈』有没有发出相逢过这种困境?你批哩啪啦写了同一十分堆,征求团队里其他成员的意见,结果,结果,没人理你。用/Cartman这个Slack上的机器人吧,它见面一直帮您催促其他人回复,直到他们不怕范为止。
Get Cartman.png

2. 长配置

@Configuration //标记配置类
@EnableSwagger2 //开启在线接口文档
public class Swagger2Config {
    /**
     * 添加摘要信息(Docket)
     */
    @Bean
    public Docket controllerApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("标题:某公司_用户信息管理系统_接口文档")
                        .description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
                        .contact(new Contact("一只袜子", null, null))
                        .version("版本号:1.0")
                        .build())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hehe.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

感编译者:

@灯下鼠
@Garfield
@Shawn
@小艾

  • 推送:@Shawn
  • 简书:@小艾
  • 校对:@卢灏

横流:因为精力、能力简单,我们每日只能处理部分的上榜产品。且不得不次日宣布。但咱一定全力做得又好。
随内容吗ProductX所有,未经许可禁止一切形式的转载。

3. 辑接口文档

Swagger2 基本用:

  • @Api 描述类/接口的主要用途
  • @ApiOperation 描述道用途
  • @ApiImplicitParam 描述道的参数
  • @ApiImplicitParams 描述道的参数(Multi-Params)
  • @ApiIgnore 忽略某类/方法/参数的文档

Swagger2 使用注解来修文档:

Swagger2编写接口文档相当简单,只需要以控制层(Controller)添加注解来叙述接口信息即可。例如:

package com.hehe.controller;

@Api("用户信息管理")
@RestController
@RequestMapping("/user/*")
public class UserController {

    private final static List<User> userList = new ArrayList<>();

    {
        userList.add(new User("1", "admin", "123456"));
        userList.add(new User("2", "jacks", "111111"));
    }

    @ApiOperation("获取列表")
    @GetMapping("list")
    public List userList() {
        return userList;
    }

    @ApiOperation("新增用户")
    @PostMapping("save")
    public boolean save(User user) {
        return userList.add(user);
    }

    @ApiOperation("更新用户")
    @ApiImplicitParam(name = "user", value = "单个用户信息", dataType = "User")
    @PutMapping("update")
    public boolean update(User user) {
        return userList.remove(user) && userList.add(user);
    }

    @ApiOperation("批量删除")
    @ApiImplicitParam(name = "users", value = "N个用户信息", dataType = "List<User>")
    @DeleteMapping("delete")
    public boolean delete(@RequestBody List<User> users) {
        return userList.removeAll(users);
    }
}

package com.hehe.entity;

public class User {

    private String userId;
    private String username;
    private String password;

    public User() {

    }

    public User(String userId, String username, String password) {
        this.userId = userId;
        this.username = username;
        this.password = password;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        User user = (User) o;

        return userId != null ? userId.equals(user.userId) : user.userId == null;
    }

    @Override
    public int hashCode() {
        int result = userId != null ? userId.hashCode() : 0;
        result = 31 * result + (username != null ? username.hashCode() : 0);
        result = 31 * result + (password != null ? password.hashCode() : 0);
        return result;
    }

    public String getUserId() {
        return userId;
    }

    public void setUserId(String userId) {
        this.userId = userId;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

4. 查看接口文档

编写文档完成以后,启动时项目,在浏览器打开:
[
http://localhost:8080/swagger-ui.html
] , 看到效果如下:

葡京在线开户 8

来瞧save 方法的切切实实讲述,可以见到Swagger 2.7.0
版本对参数列表进行了改版,直接输入参数,更便民开展测试操作:

葡京在线开户 9

5. 测试接口

Swagger2的强的处不仅在于快速变化整洁优雅的RestAPI文档,同时支持接口方法的测试操作(类似于客户端PostMan)。

为询问用户列表为条例,无参数输入,直接点击“试一下”按钮:

葡京在线开户 10

然后可以看来以JSON格式返回的用户列表信息,很有利有木有:

葡京在线开户 11

吓了,关于Swagger2在品种中的利用教程就到这边。

源码下载: SpringBoot +Swagger2
使用教程

专题阅读:《SpringBoot
布道系列》