swagger api docs

main
Vks 3 months ago
parent e16dd37a56
commit 064bf4c781

@ -5,7 +5,7 @@
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.3</version>
<version>3.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.cyberlanting</groupId>
@ -27,7 +27,7 @@
<url/>
</scm>
<properties>
<java.version>8</java.version>
<java.version>17</java.version>
</properties>
<dependencies>
<dependency>
@ -44,15 +44,11 @@
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j</artifactId>
<version>3.0.2</version>
<type>pom</type>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.8.5</version>
</dependency>
</dependencies>
<!-- <build>-->

@ -1,10 +1,8 @@
package com.cyberlanting.Assignments;
import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@EnableSwagger2Doc
@SpringBootApplication
public class AssignmentsApplication {

@ -1,6 +0,0 @@
package com.cyberlanting.Assignments.config;
public class Swagger2Config {
private ApiInfo admian
}

@ -0,0 +1,15 @@
package com.cyberlanting.Assignments.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class SwaggerConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/swagger-ui/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/springdoc-openapi-ui/")
.resourceChain(false);
}
}

@ -1,10 +1,13 @@
package com.cyberlanting.Assignments.controller;
import com.cyberlanting.Assignments.pojo.User;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
import java.util.*;
@Tag(name = "用户模块")
@RestController
@RequestMapping("/users")
public class UserController {
@ -17,6 +20,7 @@ public class UserController {
*
* @return
*/
@Operation(summary = "获取用户列表")
@GetMapping("/")
public List<User> getUserList() {
// 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
@ -30,6 +34,7 @@ public class UserController {
* @param user
* @return
*/
@Operation(summary = "新建用户")
@PostMapping("/")
public String postUser(@RequestBody User user) {
// @RequestBody注解用来绑定通过http请求中application/json类型上传的数据
@ -43,6 +48,7 @@ public class UserController {
* @param id
* @return
*/
@Operation(summary = "根据id获取用户")
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
// url中的id可通过@PathVariable绑定到函数的参数中
@ -56,6 +62,7 @@ public class UserController {
* @param user
* @return
*/
@Operation(summary = "根据id修改用户")
@PutMapping("/{id}")
public String putUser(@PathVariable Long id, @RequestBody User user) {
User u = users.get(id);
@ -71,6 +78,7 @@ public class UserController {
* @param id
* @return
*/
@Operation(summary = "删除用户")
@DeleteMapping("/{id}")
public String deleteUser(@PathVariable Long id) {
users.remove(id);

@ -1,3 +1,11 @@
spring:
application:
name: Assignments
springdoc:
api-docs:
enable: true
path: /v3/api-docs
swagger-ui:
enable: true
path: /swagger-ui.html

Loading…
Cancel
Save