When there is a need for interface docking, development finally no longer has to worry about the difficulty of writing API documents, and there is no need to rewrite interface documents one by one! Install this IDEA plug-in to import documents into Postcat in one step.

This plug-in is simple to operate, easy to use, and can
Let the developer save
The job of document writing is more focused on development.The plug-in analyzes user comments for interface analysis, and finally generates interface documents and uploads them to the Postcat server, enabling developers to manage and share APIs on Postcat, improving collaboration capabilities and development speed.

What is the difference with Swagger?

The Postcat plugin will not invade the code, and there is no need to add any jar package dependencies

The plug-in analyzes user comments for interface analysis, and finally generates interface documents and uploads them to the Postcat server, enabling developers to manage and share APIs on Postcat, improving collaboration capabilities and development speed.

Postcat provides a variety of extended comments,like
@requiredthese annotations can be customized or compatible with existing annotations in the settings interface.

Postcat also provides a comment generation function, for classes and methods with no or only a few annotations, developers do not need to manually add them. This function can analyze the meaning of method fields and automatically generate annotations. Developers only need to check or fine-tune according to actual scenarios to generate a relatively complete API document.

If the original comment is insufficient, Postcat will supplement the comment by adding, when removing comments, only those extended comments provided by Postcat will be removed, and the user’s own comments will not be destroyed. At the same time, developers can also use the “intent” function to locally generate plug-in comments, and make adjustments and modifications.

Postcat provides a variety of
The upload method is convenient for developers to use in different scenarios:

  • For existing projects using Postcat for the first time, developers can use the
    Toolsunder the group
    Upload Project Api DocTo complete the project-level interface upload.

  • For the Controller created under the new requirement, after completing the interface definition, the developer can right-click the menu and select
    Upload All Api To upload all files at a single file level, so that there are documents first and then logic, and the front-end and back-end work will no longer be blocked serially.

  • For the modification of a certain part of a single interface, there is no need to upload all of them. Developers can right-click the menu and select
    Upload ApiFunction, this function will display the interface information of the current editing class, and provide an interface preview and interface selection interface, so that users can check and upload the target API that needs to be updated or uploaded.

How to install and configure?

IDEA version needs to be greater than IntelliJ IDEA 2022.03

Search in IDEA “Settings – Plugins – Marketplace”
Postcat,turn up
Postcat Just install the plugin. At the same time, it can also be downloaded and installed in the IDEA plug-in market. When the local IDEA is not automatically awakened, you can directly drag the zip package into IDEA to complete the installation/update.

  1. Fill in the configuration information

The configuration information needs to be filled in for the first upload, and the configuration information items are independent.

Ways to obtain configuration information:
log in
Postcat enters the project to obtain Token, WorkspaceID and ProjectID.

  1. Server is filled in by default: https://postcat.com/api, users do not need to modify

  2. Token acquisition

    1. 3. Get WorkspaceID and ProjectID

    Enter the project settings page, click the “question mark” on the right side of the project name

    1. 4. StringType determines the string type of the input and output parameters. Only when the parameter name conforms to the hump specification at the beginning will the change be found. The preview window can see the result of the change

    1. When the parameter named
    userInfochoose camelCase, it is still
    userInfowhich is the default option

    2. When the parameter name is
    userInfoselect lower_underscore, will become

    3. When the parameter name is
    userInfoselect UPPER_UNDERSCORE, it will become

    1. Precautions

    1. Before parsing and uploading, please ensure that IDEA has been built in the project and related dependencies have been downloaded.

    2. It is strongly recommended to use the comments defined by the plug-in. The plug-in has a powerful function of generating comments. It is strongly recommended to generate the comments of the plug-in before editing and uploading. The comments can also be customized in the settings.

    3. When plugin annotations are not recognized, only for
      Spring MVC,
      Swagger(OpenAPI).v3The annotations only do some simple support. To avoid missing required parameters, it is recommended to use plugin annotations.

    4. The generate annotations feature will
      Spring MVC,
      Swagger.v2 and
      Swagger(OpenAPI).v3The annotations only do some simple support, and don’t let you rewrite it.

    5. HTTPThe interface judges only through routing and request methods to perform overlay update processing

    6. For the API that has been uploaded, it has been manually modified on the web. It is not recommended to use the upload function, because the plug-in upload will overwrite the previous content.

    7. After generating/hand typing the plug-in javadoc, the interface uri, request method (GET/POST), etc. have been modified, and the plug-in javadoc needs to be manually modified, otherwise the plug-in will still recognize the old plug-in javadoc information.

    8. Auto-generated class annotations are uploaded by default to
      默认分组please fill in the real group by yourself, and the group is identified by name.

      1. For multi-level grouping, use
        .Separated, for example, the interface needs to be passed to
        第三方under the group
        用户For grouping, the group-name should be filled with third-party.user.

    9. @group-nameComments are supported at the method level and are not generated by default. You can manually add them to method comments, and the plug-in will help you save the current method into the corresponding group.

    10. project level api scan and upload, top menu
      [Tools -> Upload Project Api Doc]see the specific usage rules

    11. Generated class annotations are not generated by default
      @requirednote, only for
      javax.validation.constraints.NotNullAnnotated fields are generated.

    12. not recommended
      @remarkComments, the plug-in retains the recognition function and splices the content into the field description, and the generated class comments will not be automatically generated.

    13. pass
      @PathVariablethe POST method recognizes the parameter as the Formdata type by default, and the GET method recognizes the parameter as the query type by default.

    14. //The marked annotation cannot be recognized, please use
      /** */logo.

    Learn about Postcat:

    Postcat It is a powerful open source, cross-platform (Windows, Mac, Linux, Browsers…) API development and testing tool that supports REST, Websocket and other protocols (soon to support GraphQL, gRPC, TCP, UDP), helping you accelerate the completion of API development and the test works.

    Postcat core functions:

    1. APIs

      Document management:Visualize API design and generate API documentation

    2. APIs

      test:Automatically generate test parameters, automatically generate test cases, and visualize data editing

    3. Plug-in expansion:Many plug-ins extend product functions and create an API development platform that belongs to you and your team

    4. Mock:Automatically generate Mock according to documents, or create custom Mock to meet complex scenarios

    5. Teamwork:It can not only realize API sharing but also create cloud space to collaborate together

    Advantages of Postcat:

    1. You can test without logging in:Eliminate the tedious operation of verifying and logging in

    2. Simple interface:No redundant functions and complex options

    3. free:Small and medium teams and personal use

    4. Rich plugins:Support up to 22 plugins for data migration, themes, API security, etc.

    5. Domestic:Can better understand the needs of domestic users and communicate with the development team without barriers

    6. Comprehensive user documentation:Follow the operation to get started quickly

    More Issues! More Feedback!

    If you have any questions during use, you can submit an Issue online (this open source method is strongly recommended), and the question itself is already contributing to the community:


    If you like it, you might as well support it with Star

    This project is open source, if you think this project is not bad, you might as well click a Star to support it!





    #IDEA #plugin #Generating #interface #documentation #fast #News Fast Delivery #Chinese #Open #Source #Technology #Exchange #Community

    Leave a Comment

    Your email address will not be published. Required fields are marked *