Sugestão para a abstração de todas as tags

Sugestão para a abstração de todas as tags

Encerrada

Fórum Especialista Spring REST Documentação da API com OpenAPI, Swagger UI e SpringFox Descrevendo tags na documentação e associando com controllers

Gabriel Monteiro Fernandes 01/07/2020 às 21:09
Encontrei uma maneira de abstrair a listagem das tags em um método para não poluir o método principal:
```
private Tag[] tags() {
    return Arrays.asList(
        new Tag("City", "Manage the cities"),
        new Tag("Cuisine", "Manage the cuisines"),
        new Tag("Group", "Manage the groups"),
        new Tag("Group permission", "Manage the groups permissions"),
        new Tag("Order", "Manage the orders"),
        new Tag("Order status", "Manage the orders status"),
        new Tag("Payment method", "Manage the payment methods"),
        new Tag("Product photo", "Manage the products photos"),
        new Tag("Restaurant", "Manage the restaurants"),
        new Tag("Restaurant payment method", "Manage the restaurants payment methods"),
        new Tag("Restaurant product", "Manage the restaurants products"),
        new Tag("Restaurant user", "Manage the restaurants owners"),
        new Tag("State", "Manage the states"),
        new Tag("Statistic", "Manage the statistics"),
        new Tag("User", "Manage the users"),
        new Tag("User group", "Manage the users groups")
    ).toArray(new Tag[0]);
}
```
E aí no tags do Docket():
```
.tags(tags()[0], tags());
```
Encontrei uma maneira de abstrair a listagem das tags em um método para não poluir o método principal: [code lang="java"] private Tag[] tags() { return Arrays.asList( new Tag("City", "Manage the cities"), new Tag("Cuisine", "Manage the cuisines"), new Tag("Group", "Manage the groups"), new Tag("Group permission", "Manage the groups permissions"), new Tag("Order", "Manage the orders"), new Tag("Order status", "Manage the orders status"), new Tag("Payment method", "Manage the payment methods"), new Tag("Product photo", "Manage the products photos"), new Tag("Restaurant", "Manage the restaurants"), new Tag("Restaurant payment method", "Manage the restaurants payment methods"), new Tag("Restaurant product", "Manage the restaurants products"), new Tag("Restaurant user", "Manage the restaurants owners"), new Tag("State", "Manage the states"), new Tag("Statistic", "Manage the statistics"), new Tag("User", "Manage the users"), new Tag("User group", "Manage the users groups") ).toArray(new Tag[0]); } [/code] E aí no tags do Docket(): [code lang="java"] .tags(tags()[0], tags()); [/code]

5 Respostas
Eduardo Rodrigues Tutor 02/07/2020 às 20:03

Muito bom, Gabriel! Obrigado por continuar compartilhando suas soluções :) Quando tivermos funcionalidade de fixar mensagens, com certeza essa ficaria fixada nesta aula.

Bruno Drugowick 11/07/2020 às 19:34

Opa, excelente. Até voltei aqui pra usar o mesmo esquema do Gabriel. Só uma coisa que não achei que faz sentido é criar uma lista e depois transformar em Array pra retornar ao invés de já criar um Array direto, então fiz assim:

private Tag[] tags() {
    return new Tag[] {
        new Tag("City", "Manage the cities"),
        new Tag("Cuisine", "Manage the cuisines"),
        new Tag("Group", "Manage the groups"),
        new Tag("Group permission", "Manage the groups permissions"),
        new Tag("Order", "Manage the orders"),
        new Tag("Order status", "Manage the orders status"),
        new Tag("Payment method", "Manage the payment methods"),
        new Tag("Product photo", "Manage the products photos"),
        new Tag("Restaurant", "Manage the restaurants"),
        new Tag("Restaurant payment method", "Manage the restaurants payment methods"),
        new Tag("Restaurant product", "Manage the restaurants products"),
        new Tag("Restaurant user", "Manage the restaurants owners"),
        new Tag("State", "Manage the states"),
        new Tag("Statistic", "Manage the statistics"),
        new Tag("User", "Manage the users"),
        new Tag("User group", "Manage the users groups")
    };
}

Abraços.

Gabriel Monteiro Fernandes 11/07/2020 às 19:38

Oi Bruno, Depois que eu aprendi esta maneira. Melhor de fato.
Fernando de Oliveira Melo 07/12/2020 às 20:43
Olá, pessoal. Aqui na solução proposta pelo Gabriel, entendi que ele instanciou um Array com as descrições customizadas para todos os controladores, mas não entendi a chamada no Docket:
```
.tags(tags()[0], tags());
```
Qual é a lógica dessa sintaxe? Obrigado. Abs
Alexandre Moraes Tannus Tutor 08/12/2020 às 11:39
Bom dia Fernando, Seguindo a documentação do Springfox, a função tags recebe no mínimo dois parâmetros, sendo o primeiro o item número 1 da lista de tags e o segundo a lista completa dos parâmetros, no seguinte formato.
```
public Docket tags(Tag first, Tag... remaining)
```
Como nesta aula apenas uma Tag foi criada, o parâmetro remaining pode ser omitido. Em aulas posteriores serão adicionadas novas tags, fazendo este parâmetro remaining se tornar um conjunto crescente de valores de Tags. No código postado pelo Gabriel ele passa como Tag first o item da posição zero do vetor e como Tag... remaining o vetor com todas as Tags, deixando a implementação mais limpa e fácil de manter.