Ruoyi 프레임워크의 Swagger 인터페이스 문서

1:
@Api: @Controller와 병렬로 요청된 클래스에 배치하여 학생 클래스
태그 = "이 클래스의 기능 설명" 과 같이 클래스의 기능을 설명합니다.
예:
여기에 이미지 설명을 삽입하세요. 표시 효과:

여기에 이미지 설명을 삽입하세요.
2: 메소드에 사용됨
@ApiOperation : "메서드의 기능을 설명하기 위해 요청된 메소드에 사용됨"
value = "메서드의 기능 설명"
Notes = "메서드에 대한 설명"
—————————— —— ————
@ApiImplicitParams : 매개변수 설명 세트를 포함하여 요청 메소드에 사용됨
@ApiImplicitParam : 단일 매개변수
이름 설명: 매개변수 이름
값: 매개변수에 대한 한자 설명 및 설명
필수: 매개변수가 필수인지 여부 전달된
paramType: 매개변수는 Where에 배치됩니다.
· 헤더 --> 요청 매개변수 가져오기: @RequestHeader
· 쿼리 --> 요청 매개변수 가져오기: @RequestParam
· 경로(편안한 인터페이스용) –> 요청 매개변수 가져오기: @PathVariable
· 본문(요청 body) – > @RequestBody 사용자 사용자
· 양식(일반 양식 제출)
dataType: 매개변수 유형, 기본값 String, 기타 값 ​​dataType="int"
defaultValue: 매개변수의 기본값
——————————— ———
@ApiResponses : 메소드가 반환하는 객체에 대한 설명
@ApiResponse : 각 매개변수에 대한 설명
코드: 숫자(예: 400)
메시지: "요청 매개변수가 채워지지 않았습니다."와 같은 정보
응답: 해당 요청을 던지는 클래스 예외

예:
여기에 이미지 설명을 삽입하세요.
효과:
여기에 이미지 설명을 삽입하세요. ![여기에 이미지 설명 삽입](https://img-blog.csdnimg.cn/6a82여기에 이미지 설명을 삽입하세요.

おすすめ

転載: blog.csdn.net/qq_40579139/article/details/125894189