Spring boot 启动添加访问地址和swagger地址输出
在Spring Boot应用中添加访问地址和Swagger文档输出,通常涉及以下步骤:
- 添加访问地址:在Spring Boot中,你可以通过
@RequestMapping
或@GetMapping
等注解来指定控制器方法的访问地址。 - 集成Swagger:使用Swagger可以生成API文档,并提供在线测试功能。你需要添加Swagger的依赖,并配置Swagger。
以下是一个简单的示例:
添加Maven依赖(pom.xml):
<!-- Swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
Swagger配置类(SwaggerConfig.java):
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.build();
}
}
控制器类(YourController.java):
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class YourController {
@GetMapping("/hello")
public String hello() {
return "Hello World!";
}
}
启动Spring Boot应用后,你可以通过访问http://<host>:<port>/api/hello
来访问你定义的地址,通过访问http://<host>:<port>/swagger-ui.html
来查看Swagger文档。
请注意,具体的端口和主机取决于你的部署环境和配置。以上代码示例使用了默认的端口8080。如果你使用的是不同的端口或者有自定义的配置,请相应地修改访问地址。
评论已关闭