IDEA 플러그인이 새로워졌습니다! 인터페이스 문서 생성이 그만큼 빠릅니다!

인터페이스 도킹이 필요할 때 개발은 마침내 더 이상 API 문서 작성의 어려움에 대해 걱정할 필요가 없으며 인터페이스 문서를 하나씩 다시 작성할 필요가 없습니다! 이 IDEA 플러그인을 설치하여 한 번에 문서를 Postcat으로 가져오십시오.

무엇이 업데이트되었나요?

이 플러그인은 작동 및 사용이 간편 하여 개발자가 API 문서 작성 작업을 저장하고 개발에 더 집중할 수 있습니다. 플러그인은 인터페이스 분석을 위한 사용자 댓글을 분석하고 최종적으로 인터페이스 문서를 생성하여 Postcat 서버에 업로드함으로써 개발자가 Postcat에서 API를 관리하고 공유할 수 있도록 하여 협업 기능과 개발 속도를 향상시킵니다.

Swagger와의 차이점은 무엇입니까?

Postcat 플러그인은 코드를 침범하지 않으며 jar 패키지 종속성을 추가할 필요가 없습니다.

플러그인은 인터페이스 분석을 위한 사용자 댓글을 분석하고 최종적으로 인터페이스 문서를 생성하여 Postcat 서버에 업로드함으로써 개발자가 Postcat에서 API를 관리하고 공유할 수 있도록 하여 협업 기능과 개발 속도를 향상시킵니다.

@path Postcat은 , @url , @method , @name 및 @hidden 와 같은 다양한 확장 주석을 제공하며 @required 설정 인터페이스에서 사용자 정의하거나 기존 주석과 호환할 수 있습니다.

또한 Postcat은 주석 생성 기능을 제공하여 주석이 없거나 적은 클래스 및 메서드에 대해 개발자가 수동으로 추가할 필요 없이 메서드 필드의 의미를 분석하여 자동으로 주석을 생성할 수 있습니다. 개발자는 실제 시나리오에 따라 확인하거나 미세 조정하기만 하면 비교적 완전한 API 문서를 생성할 수 있습니다.

원본 주석이 부족할 경우 Postcat에서 추가 주석을 추가하며 , 주석 제거 시 Postcat에서 제공하는 확장 주석만 제거되며 사용자 자신의 주석은 파기되지 않습니다. 동시에 개발자는 "의도" 기능을 사용하여 로컬에서 플러그인 주석을 생성하고 조정 및 수정할 수 있습니다.

Postcat은 개발자가 다양한 시나리오에서 편리하게 사용할 수 있는 다양한 API 업로드 방법을 제공합니다.

Postcat을 처음 사용하는 기존 프로젝트의 경우 개발자는 메인 메뉴 아래의 Tools 그룹을 Upload Project Api Doc 프로젝트 수준의 인터페이스 업로드를 완료할 수 있습니다.
새로운 요구 사항에 따라 생성된 컨트롤러의 경우 인터페이스 정의를 완료한 후 개발자는 메뉴를 마우스 오른쪽 버튼으로 클릭하고 단일 파일 수준에서 모든 파일을 업로드 Upload All Api 하도록 종료 작업은 더 이상 순차적으로 차단되지 않습니다.
일부 개별 인터페이스의 수정을 위해 모든 인터페이스를 업로드할 필요가 없습니다.개발자는 메뉴를 마우스 오른쪽 버튼으로 클릭하고 Upload Api 기능을 이 기능은 현재 편집 클래스의 인터페이스 정보를 표시하고 인터페이스 미리보기 및 인터페이스 선택 인터페이스를 제공합니다. , 업로드된 대상 API는 정보 확인 및 업로드를 수행합니다.

설치 및 구성 방법

IDEA 버전은 IntelliJ IDEA 2022.03보다 높아야 합니다.

IDEA "Settings-Plug-In-Marketplace"에서 검색하여 플러그인 Postcat 설치를 찾습니다 . Postcat 동시에 IDEA 플러그인 마켓 에서도 다운로드 및 설치가 가능 하며, 로컬 IDEA가 자동으로 활성화되지 않을 경우 zip 패키지를 IDEA로 직접 드래그하여 설치/업데이트를 완료할 수 있습니다.

구성 정보 입력

최초 업로드 시 구성 정보를 입력해야 하며 구성 정보 항목은 독립적입니다.

구성 정보를 얻는 방법: Postcat 에 로그인 하고 프로젝트를 입력하여 Token, WorkspaceID 및 ProjectID를 얻습니다.

서버는 기본적으로 채워져 있습니다: https://postcat.com/api, 사용자는 수정할 필요가 없습니다.
토큰 획득
3. WorkspaceID 및 ProjectID 가져오기

프로젝트 설정 페이지에 들어가 프로젝트 이름 오른쪽에 있는 "물음표"를 클릭합니다.

4. StringType은 입력 및 출력 매개변수의 문자열 유형을 결정합니다. 매개변수 이름이 처음에 험프 사양을 준수하는 경우에만 변경 사항이 발견됩니다. 미리 보기 창에서 변경 결과를 볼 수 있습니다.

1. 매개변수 이름이 이면 camelCase를 선택합니다. userInfo 여전히 기본 옵션 userInfo 입니다.

2. 매개변수 이름에서 userInfo lower_underscore를 선택하면 됩니다. user_info

3. 매개변수 이름을 userInfo UPPER_UNDERSCORE로 선택하면 USER_INFO

지침

구문 분석 및 업로드하기 전에 IDEA가 프로젝트에 빌드되었고 관련 종속성이 다운로드되었는지 확인하십시오.
플러그인에서 정의한 주석을 사용하는 것이 좋습니다. 플러그인에는 강력한 주석 생성 기능이 있습니다. 편집 및 업로드 전에 플러그인의 주석을 생성하는 것이 좋습니다. 주석도 가능합니다. 설정에서 사용자 지정합니다.
플러그인 주석이 인식되지 않으면 , Spring MVC 및 의 Swagger.v2 주석에 대한 부분적인 지원만 있습니다. Swagger(OpenAPI).v3 필수 매개변수 누락을 방지하려면 플러그인 주석을 사용하는 것이 좋습니다.
주석 생성 기능은 Spring MVC , 및 Swagger.v2 의 주석에 대한 일부 간단한 지원만 제공하며 주석을 다시 작성할 수는 없습니다. Swagger(OpenAPI).v3
HTTP 인터페이스는 오버레이 업데이트 처리를 수행하기 위해 라우팅 및 요청 방법을 통해서만 판단합니다.
업로드한 API는 웹상에서 수동으로 수정한 것으로, 플러그인 업로드 시 이전 내용을 덮어쓰게 되므로 업로드 기능 사용을 권장하지 않습니다.
플러그인 javadoc을 생성/수동 입력한 후 인터페이스 uri, 요청 방법(GET/POST) 등이 수정되었으며 플러그인 javadoc을 수동으로 수정해야 합니다. 그렇지 않으면 플러그인이 계속 인식합니다. 이전 플러그인 javadoc 정보.
자동으로 생성된 클래스 주석은 기본적으로 업로드되며 默认分组 실제 그룹을 직접 입력하면 그룹이 이름으로 식별됩니다.
1. 다단계 그룹의 경우 로 . 구분합니다 . 第三方 用户
@group-name 주석은 메서드 수준에서 지원되며 기본적으로 생성되지 않습니다. 메서드 주석에 주석을 수동으로 추가할 수 있으며 플러그인을 통해 현재 메서드를 해당 그룹에 저장할 수 있습니다.
프로젝트 수준의 API 스캔 및 업로드에 대해서는 [Tools -> Upload Project Api Doc] 특정 사용 규칙에 대한 상단 메뉴를 참조하십시오 项目级上传 .
생성된 클래스 @required 주석은 javax.validation.constraints.NotNull 주석이 있는 필드에 대해서만 생성됩니다.
@remark 주석을 사용하는 것은 권장되지 않습니다 . 플러그인은 인식 기능을 유지하고 콘텐츠를 필드 설명에 연결하며 생성된 클래스 주석은 자동으로 생성되지 않습니다.
기본적으로 @PathVariable POST 메소드는 기본적으로 매개변수를 Formdata 유형으로 인식하고 GET 메소드는 기본적으로 매개변수를 쿼리 유형으로 인식합니다.
// 표시된 댓글을 인식할 수 없습니다. /** */ 표시를 .

포스트캣에 대해 알아보기:

Postcat 은 REST, Websocket 및 기타 프로토콜(곧 GraphQL, gRPC, TCP, UDP 지원 예정)을 지원하는 강력한 오픈 소스, 크로스 플랫폼(Windows, Mac, Linux, Browsers...) API 개발 및 테스트 도구입니다. API 개발 및 테스트 작업 완료를 가속화합니다.

Postcat 핵심 기능:

API 문서 관리: API 설계 시각화 및 API 문서 생성
API 테스트: 테스트 매개변수 자동 생성, 테스트 케이스 자동 생성, 시각적 데이터 편집
플러그인 확장: 많은 플러그인이 제품 기능을 확장하고 귀하와 귀하의 팀에 속하는 API 개발 플랫폼을 생성합니다.
Mock: 문서에 따라 자동으로 Mock을 생성하거나 복잡한 시나리오를 충족하기 위해 맞춤형 Mock을 생성합니다.
팀 협업: API 공유를 실현할 수 있을 뿐만 아니라 함께 협업할 수 있는 클라우드 공간을 생성할 수 있습니다.

포스트캣의 장점:

로그인 없이 테스트: 번거로운 로그인 확인 작업을 저장합니다.
간단한 인터페이스: 중복 기능 및 복잡한 옵션 없음
무료: 중소 규모 팀 및 개인 용도
풍부한 플러그인: 데이터 마이그레이션, 테마, API 보안 등을 위해 최대 22개의 플러그인을 지원합니다.
국내 : 국내 사용자의 니즈를 더 잘 이해하고, 개발팀과 장벽 없이 소통할 수 있음
완벽한 사용자 설명서: 신속하게 시작하려면 작업을 따르십시오.

더 많은 이슈! 더 많은 피드백!

사용 중에 질문이 있는 경우 온라인으로 문제를 제출할 수 있으며(이 오픈 소스 방법을 적극 권장함) 질문 자체가 이미 커뮤니티에 기여하고 있습니다.

https://github.com/Postcatlab/postcat/issues

당신이 그것을 좋아한다면, 당신은 스타로 그것을 지원하는 것이 좋습니다

이 프로젝트는 오픈 소스입니다. 이 프로젝트가 나쁘지 않다고 생각되면 별표를 클릭하여 지원하세요!

깃허브 ：

https://github.com/Postcatlab/postcat

지티:

https://gitee.com/eolink_admin/postcat