spring-boot集成springfox(Swagger) (ApiDoc接口文档)

最新推荐文章于 2024-08-09 07:29:17 发布

Lance_xu_

最新推荐文章于 2024-08-09 07:29:17 发布

阅读量4.6k

点赞数

分类专栏： java springboot Swagger 文章标签： api 文档框架开源 maven

本文链接：https://blog.csdn.net/u013821825/article/details/52906056

版权

本文档介绍了如何将Springfox集成到Spring Boot项目中，利用它来生成RESTful API接口文档。通过添加maven依赖，进行必要配置，并使用restful注解对Controller方法进行描述，最后可以通过访问http://localhost:8080/swagger-ui.html来查看生成的接口文档。

摘要由CSDN通过智能技术生成

Springfox的前身是swagger-springmvc，是一个开源的API doc框架，可以将我们的Controller的方法以文档的形式展现，基于Swagger。

官网地址：http://springfox.github.io/springfox/

1、maven依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency&g