21、使用Swagger实现自文档化API及API安全保障

使用Swagger实现自文档化API及API安全保障

1. 利用Swagger实现自文档化API

1.1 Swagger简介

Swagger是一种强大的工具，它能读取机器可读的JSON文件，为API自动生成文档。同时，Swagger规范还可用于自动生成多种语言的客户端代码，加速与API集成的过程，甚至支持生成Scala和Java的服务器端代码。Scalatra对Swagger提供了内置支持，只需在控制器和操作中添加一些额外信息，Scalatra就能自动为应用中的API和模型生成完整的Swagger规范。

1.2 配置应用以使用Swagger

1.2.1 添加依赖

在 build.sbt 文件中添加Swagger依赖：

"org.scalatra" %% "scalatra-swagger" % ScalatraVersion,

退出 sbt 控制台，在应用的顶级目录中再次输入 sbt 以拉取依赖，然后运行 ~jetty:start 启动服务器并开启代码重载。

1.2.2 添加Swagger控制器

创建一个新文件 HackersSwagger.scala ，内容如下：

package com.constructiveproof.hackertra