O plug-in IDEA é novo! Gerar documentação de interface é muito rápido!

Quando há necessidade de docking de interface, o desenvolvimento finalmente não precisa mais se preocupar com a dificuldade de escrever documentos de API e não há necessidade de reescrever documentos de interface um por um! Instale este plug-in IDEA para importar documentos para o Postcat em uma única etapa.

O que foi atualizado?

Este plug-in é fácil de operar e usar, permitindo que os desenvolvedores economizem o trabalho de escrever documentos de API e se concentrem mais no desenvolvimento. O plug-in analisa os comentários do usuário para análise de interface e, finalmente, gera documentos de interface e os carrega no servidor Postcat, permitindo que os desenvolvedores gerenciem e compartilhem APIs no Postcat, melhorando os recursos de colaboração e a velocidade de desenvolvimento.

Qual é a diferença com o Swagger?

O plug-in Postcat não invadirá o código e não há necessidade de adicionar nenhuma dependência de pacote jar

O plug-in analisa os comentários do usuário para análise de interface e, finalmente, gera documentos de interface e os carrega no servidor Postcat, permitindo que os desenvolvedores gerenciem e compartilhem APIs no Postcat, melhorando os recursos de colaboração e a velocidade de desenvolvimento.

O Postcat fornece uma variedade de anotações estendidas, como , , , e @path , @url que @method podem ser personalizadas ou compatíveis com as anotações existentes na interface de configuração. @name @hidden @required

Além disso, o Postcat também fornece uma função de geração de comentários . Para classes e métodos com poucos ou nenhum comentário, os desenvolvedores não precisam adicioná-los manualmente. Essa função pode analisar o significado dos campos do método e gerar comentários automaticamente. Os desenvolvedores só precisam verificar ou ajustar de acordo com os cenários reais para gerar um documento de API relativamente completo.

Se as anotações originais forem insuficientes, o Postcat adicionará anotações adicionais Ao remover anotações, apenas as anotações estendidas fornecidas pelo Postcat serão removidas e as próprias anotações do usuário não serão destruídas. Ao mesmo tempo, os desenvolvedores também podem usar a função "intenção" para gerar comentários de plug-in localmente e fazer ajustes e modificações.

Postcat fornece uma variedade de métodos de upload de API , que são convenientes para os desenvolvedores usarem em diferentes cenários:

Para projetos existentes que usam o Postcat pela primeira vez, os desenvolvedores podem usar Tools o grupo Upload Project Api Doc para concluir o upload da interface no nível do projeto.
Para o Controller criado sob novos requisitos, após concluir a definição da interface, o desenvolvedor pode clicar com o botão direito do mouse no menu e selecionar Upload All Api o upload de todos os arquivos em um único nível de arquivo, para que haja documentos antes da lógica e o front-end e back- trabalho final não será mais bloqueado em série.
Para a modificação de algumas interfaces individuais, não há necessidade de fazer upload de todas elas. Os desenvolvedores podem clicar com o botão direito do mouse no menu e selecionar Upload Api Function Esta função exibirá as informações da interface da classe de edição atual e fornecerá visualização e seleção de interface , para que os usuários possam verificar a necessidade de atualização ou A API de destino carregada executa a verificação e o upload de informações.

Como instalar e configurar?

A versão do IDEA precisa ser maior que o IntelliJ IDEA 2022.03

Pesquise em IDEA "Settings-Plug-In-Marketplace" Postcat e localize Postcat a instalação do plug- in. Ao mesmo tempo, ele também pode ser baixado e instalado no mercado de plug-ins IDEA.Quando o IDEA local não for ativado automaticamente, você pode arrastar o pacote zip diretamente para o IDEA para concluir a instalação/atualização.

Preencha as informações de configuração

As informações de configuração precisam ser preenchidas para o primeiro upload e os itens de informações de configuração são independentes.

Maneiras de obter informações de configuração: Faça login no Postcat e insira o projeto para obter Token, WorkspaceID e ProjectID.

O servidor é preenchido por padrão: https://postcat.com/api, os usuários não precisam modificar
Aquisição de token
3. Obtenha WorkspaceID e ProjectID

Entre na página de configurações do projeto, clique no "ponto de interrogação" no lado direito do nome do projeto

4. StringType determina o tipo de string dos parâmetros de entrada e saída. Somente quando o nome do parâmetro estiver em conformidade com a especificação do hump no início, a alteração será encontrada. A janela de visualização pode ver o resultado da alteração

1. Quando o parâmetro for nomeado , selecione camelCase, userInfo ainda userInfo é a opção padrão

2. Quando o nome do parâmetro userInfo for selecionado, underscore, ele se tornará user_info

3. Quando o nome do parâmetro userInfo , selecione UPPER_UNDERSCORE, ele se tornará USER_INFO

Precauções

Antes de analisar e carregar, certifique-se de que o IDEA foi criado no projeto e que as dependências relacionadas foram baixadas.
É altamente recomendável usar os comentários definidos pelo plug-in. O plug-in tem uma poderosa função de geração de comentários. É altamente recomendável gerar os comentários do plug-in antes de editar e fazer upload. Os comentários também podem ser personalizado nas configurações.
Quando as anotações de plug-in não são reconhecidas, há apenas suporte parcial para anotações de Spring MVC , e Swagger.v2 . Swagger(OpenAPI).v3 Para evitar a falta de parâmetros obrigatórios, é recomendável usar anotações de plug-in.
A função de gerar anotações fornecerá apenas algum suporte simples para anotações de Spring MVC , e Swagger.v2 , sem permitir que você as reescreva. Swagger(OpenAPI).v3
HTTP A interface julga apenas por meio de métodos de roteamento e solicitação para executar o processamento de atualização de sobreposição
Para a API que foi carregada, ela foi modificada manualmente na Web. Não é recomendável usar a função de upload, porque o upload do plug-in substituirá o conteúdo anterior.
Depois de gerar/digitar manualmente o plug-in javadoc, a interface uri, o método de solicitação (GET/POST), etc. foram modificados e o plug-in javadoc precisa ser modificado manualmente, caso contrário, o plug-in ainda reconhecerá o informações javadoc do plug-in antigo.
As anotações de classe geradas automaticamente serão carregadas por padrão 默认分组 , preencha o grupo real por conta própria e o grupo será identificado pelo nome.
1. Para grupos de vários níveis, . separe- . Por exemplo, se você precisar transferir a interface para o grupo 第三方 sob o grupo , preencha o terceiro.usuário para o nome do grupo. 用户
@group-name Os comentários são suportados no nível do método e não são gerados por padrão. Você pode adicioná-los manualmente aos comentários do método e o plug-in o ajudará a salvar o método atual no grupo correspondente.
Para digitalização e upload de API em nível de projeto, [Tools -> Upload Project Api Doc] consulte o menu superior para regras de uso específicas 项目级上传 .
@required As anotações de classe geradas não são geradas por padrão e serão javax.validation.constraints.NotNull geradas apenas para campos com anotações.
Não é recomendado usar @remark anotações , o plug-in retém a função de reconhecimento e costura o conteúdo na descrição do campo, e as anotações de classe geradas não serão geradas automaticamente.
Por padrão @PathVariable , o método POST reconhece o parâmetro como o tipo Formdata por padrão e o método GET reconhece o parâmetro como o tipo de consulta por padrão.
// O comentário marcado não pode ser reconhecido, por favor use /** */ a marca .

Conheça o Postcat:

O Postcat é uma poderosa ferramenta de desenvolvimento e teste de API de código aberto e multiplataforma (Windows, Mac, Linux, navegadores...) acelerar a conclusão do trabalho de desenvolvimento e teste da API.

Funções principais do Postcat:

Gerenciamento de documentos da API : visualize o design da API e gere documentos da API
Teste de API : geração automática de parâmetros de teste, geração automática de casos de teste, edição visual de dados
Expansão de plug-in: muitos plug-ins estendem as funções do produto e criam uma plataforma de desenvolvimento de API que pertence a você e sua equipe
Mock: Gere automaticamente o Mock de acordo com os documentos ou crie um Mock personalizado para atender a cenários complexos
Colaboração em equipe: pode não apenas realizar o compartilhamento de API, mas também criar espaço na nuvem para colaborar em conjunto

Vantagens do Postcat:

Teste sem login: salve a tediosa operação de verificação de login
Interface simples: sem funções redundantes e opções complicadas
Gratuito: equipes pequenas e médias e uso pessoal
Plug-ins avançados: suporta até 22 plug-ins para migração de dados, temas, segurança de API, etc.
Doméstico: Pode entender melhor as necessidades dos usuários domésticos e se comunicar com a equipe de desenvolvimento sem barreiras
Documentação de usuário perfeita: siga a operação para começar rapidamente

Mais problemas, mais comentários!

Se você tiver alguma dúvida durante o uso, pode enviar um problema online (esse método de código aberto é altamente recomendado) e a própria pergunta já está contribuindo para a comunidade:

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

Se você gosta, você também pode apoiá-lo com Star

Este projeto é de código aberto, se você acha que este projeto não é ruim, clique em uma estrela para apoiá-lo!

Github:

https://github.com/Postcatlab/postcat

Gitee:

https://gitee.com/eolink_admin/postcat