IDEAプラグインが新しくなりました！インターフェイスドキュメントの生成は非常に高速です。

インターフェースのドッキングが必要な場合、開発者はついに API ドキュメントを書く難しさを心配する必要がなくなり、インターフェースドキュメントを 1 つずつ書き直す必要がなくなりました。この IDEA プラグインをインストールすると、文書を 1 ステップで 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 Function編集クラスのインターフェース情報を表示し, インターフェースプレビューとインターフェース選択インターフェースを提供します. 、ユーザーが更新の必要性を確認できるようにするか、アップロードされたターゲット 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 については、Web 上で手動で変更されています. プラグインのアップロードは以前のコンテンツを上書きするため、アップロード機能を使用することはお勧めしません.
プラグイン javadoc を生成/手入力した後、インターフェイス uri、リクエストメソッド (GET/POST) などが変更されているため、プラグイン javadoc を手動で変更する必要があります。そうしないと、プラグインは引き続き古いプラグイン javadoc 情報。
自動生成されたクラスアノテーションはデフォルトでアップロードされます 默认分组 。実際のグループを自分で入力してください。グループは名前で識別されます。
1. 複数レベルのグループの場合は、で . 区切ります。たとえば、 第三方 group 配下の 用户 グループにインターフェイスを転送する必要がある場合は、グループ名に third party.user を入力します。
@group-name コメントはメソッドレベルでサポートされており、デフォルトでは生成されません. コメントをメソッドコメントに手動で追加できます. プラグインは、現在のメソッドを対応するグループに保存するのに役立ちます.
プロジェクトレベルの API のスキャンとアップロードについては、 [Tools -> Upload Project Api Doc] 特定の使用規則についてトップメニューを参照してください 项目级上传 。
生成されたクラス @required アノテーションは、 javax.validation.constraints.NotNull アノテーション付きのフィールドに対してのみ生成されます。
@remark アノテーションの使用は推奨されません。プラグインは認識機能を保持し、コンテンツをフィールドの説明に結び付けます。生成されたクラスアノテーションは自動的に生成されません。
デフォルトでは @PathVariable 、POST メソッドはパラメータをデフォルトで Formdata 型として認識し、GET メソッドはデフォルトでパラメータをクエリ型として認識します。
// マークされたコメントは認識できません。 /** */ マークを。

Postcat について学ぶ:

Postcat は強力なオープンソースのクロスプラットフォーム (Windows、Mac、Linux、ブラウザなど) の API 開発およびテストツールであり、REST、Websocket、およびその他のプロトコル (すぐに GraphQL、gRPC、TCP、UDP をサポートする予定) をサポートします。 API 開発およびテスト作業の完了を加速します。

Postcat コア機能:

API ドキュメント管理: API 設計の視覚化と API ドキュメントの生成
API テスト:テストパラメーターの自動生成、テストケースの自動生成、ビジュアルデータ編集
プラグインの拡張: 多くのプラグインは製品の機能を拡張し、あなたとあなたのチームに属する API 開発プラットフォームを作成します
モック: ドキュメントに従ってモックを自動的に生成するか、複雑なシナリオに合わせてカスタムモックを作成します
チームコラボレーション: API 共有を実現するだけでなく、共同作業のためのクラウドスペースを作成することもできます。

Postcat の利点:

ログインせずにテスト: ログインを確認するという面倒な操作を省く
シンプルなインターフェース: 冗長な機能や複雑なオプションはありません
無料: 小規模および中規模のチームおよび個人使用
豊富なプラグイン: データ移行、テーマ、API セキュリティなどのために最大 22 個のプラグインをサポートします。
国内: 国内ユーザーのニーズをよりよく理解し、開発チームと垣根なくコミュニケーションできる
完璧なユーザードキュメント: 操作に従ってすぐに開始

より多くの問題!より多くのフィードバック!

使用中に質問がある場合は、オンラインで問題を送信できます (このオープンソースの方法を強くお勧めします)。質問自体は、既にコミュニティに投稿されています。

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

気に入ったら、スターでサポートすることもできます

このプロジェクトはオープンソースです。このプロジェクトが悪くないと思われる場合は、スターをクリックしてサポートしてください。

ギットハブ：

https://github.com/Postcatlab/postcat

ジーティー:

https://gitee.com/eolink_admin/postcat