@Configuration
@EnableSwagger2
public class SwaggerConfig {
public static final Contact DEFAULT_CONTACT = new Contact("Usama Amjad", "https://stackoverflow.com/users/4704510/usamaamjad", "hello@email.com");
public static final ApiInfo DEFAULT_API_INFO = new ApiInfo("Article API", "Article API documentation sample", "1.0", "urn:tos",
DEFAULT_CONTACT, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList<VendorExtension>());
@Bean
public Docket api() {
Set<String> producesAndConsumes = new HashSet<>();
producesAndConsumes.add("application/json");
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(DEFAULT_API_INFO)
.produces(producesAndConsumes)
.consumes(producesAndConsumes);
}
}
**步骤3:**安装完成,现在需要在controllers中记录API
@ApiOperation(value = "Returns a list Articles for a given Author", response = Article.class, responseContainer = "List")
@ApiResponses(value = { @ApiResponse(code = 200, message = "Success"),
@ApiResponse(code = 404, message = "The resource you were trying to reach is not found") })
@GetMapping(path = "/articles/users/{userId}")
public List<Article> getArticlesByUser() {
// Do your code
}
7条答案
按热度按时间um6iljoc1#
我在PHP上工作,并使用Swagger 2.0来记录API。Swagger文档是动态创建的(至少我在PHP中是这样使用的)。文档以JSON格式生成。
示例文档
这可以导入到Postman如下。
1.点击Postman UI左上角的“导入”按钮。
1.您将看到用于导入API文档的多个选项。单击“粘贴原始文本”。
1.将JSON格式粘贴到文本区域,然后单击导入。
1.您将看到所有的API都显示为“Postman Collection”,并且可以从Postman使用它。
您也可以使用“从链接导入”。在此处粘贴从Swagger或任何其他API文档工具生成JSON格式API的URL。
这是我的文档(JSON)生成文件。它是用PHP编写的。我不知道JAVA和Swagger。
fiei3ece2#
有了.Net Core,现在一切变得非常简单:
1.您可以在自己的页面上找到JSON URL:
1.单击该链接并复制URL
1.现在转到Postman并点按“导入”:
1.选择您需要的内容,您最终会得到一个不错的端点集合:
ajsxfq5m3#
接受的答案是正确的,但我将重写
java
的完整步骤。我目前正在使用
Swagger V2
与Spring Boot 2
,这是一个简单的3步过程。**步骤1:**在
pom.xml
文件中添加必需的依赖项。第二个依赖项是可选的,仅当需要Swagger UI
时使用。**步骤2:**添加配置类
**步骤3:**安装完成,现在需要在
controllers
中记录API用法:
您可以从
http://localhost:8080/v2/api-docs
访问您的文档,只需将其复制并粘贴到Postman以导入集合。**可选的Swagger UI:**您还可以通过
http://localhost:8080/swagger-ui.html
使用独立UI,而无需任何其他rest客户端,这非常好,您可以毫无麻烦地托管您的文档。oipij1gg4#
参考https://stackoverflow.com/posts/39072519答案,然后部分删除返回的内容,最后发现swagger缺少一些配置,postmat无法导入。
您需要在swagger中添加以下配置
简而言之,为ApiInfoBuilder类中的属性分配尽可能多的值
Spring引导版本:2.3.10.发布Springfox-swagger版本:2.9.2
ctehm74n5#
您可以这样做: Postman -〉导入-〉链接-〉
{root_url}/v2/api-docs
avkwfej46#
这就是我在Swagger编辑器界面中的工作方式:
方法1
将
YAML
文件内容复制到Raw Text
区域:方法2(更多步骤)
步骤1:将文件导出为JSON
第2步:使用Postman "导入"导入
JSON
文件bakd9h0s7#
您也可以在线获取一些示例swagger文件来验证这一点(如果您的swagger文档中有错误)。