2017-02-17 1 views
1

J'utilise Spring Boot et Spring Data Rest pour implémenter mon API Rest. Pour documenter, j'ai utilisé Swagger, avec ces dépendances maven:Modification du nom et de la description endpoint dans Swagger-ui

<dependency> 
     <groupId>io.springfox</groupId> 
     <artifactId>springfox-swagger2</artifactId> 
     <version>2.6.1</version> 
    </dependency> 

    <dependency> 
     <groupId>io.springfox</groupId> 
     <artifactId>springfox-swagger-ui</artifactId> 
     <version>2.6.1</version> 
    </dependency> 

    <dependency> 
     <groupId>io.springfox</groupId> 
     <artifactId>springfox-data-rest</artifactId> 
     <version>2.6.1</version> 
    </dependency> 

Je voudrais changer et personnaliser un peu ma page UI Swagger. Je veux changer le nom et la description qui apparaît sur la page html, concrètement ces noms surlignés en rouge dans la capture d'écran, mais rien ne fonctionne.

enter image description here

J'ai essayé d'ajouter l'annotation @Api à mes entités et les classes de référentiels/interfaces, mais rien ne fonctionne.

Une idée sur la façon de le personnaliser?

Merci!

+0

Pourriez-vous ajouter un exemple de ce que vous avez essayé? – jmattheis

+0

Dans mon objet entité j'ai essayé avec l'annotation suivante: '@Entity @Api (valeur =" activité Nom ", description =" activité Description ") public class Activité' mais cela n'a pas fonctionné. J'ai fait de même dans les interfaces Respository Rest, mais cela n'a pas fonctionné aussi bien. –

Répondre

0

Utilisez l'annotation @Api avec des balises et une description.

@Api(description="Device APIs", tags = "Device") 

S'il vous plaît noter que description est dépréciée, mais cela fonctionne.