web-dev-qa-db-fra.com

Comment afficher la documentation de l'API d'application à l'aide de springdoc-openapi-webflux-ui?

J'ai lu ceci https://springdoc.github.io/springdoc-openapi-demos/ documentation pour utiliser springdoc-openapi-webflux-ui. Comme le dit la documentation, je viens d'ajouter la bibliothèque springdoc-openapi-webflux-ui À mon application: implementation('org.springdoc:springdoc-openapi-webflux-ui:1.2.26')

De plus, j'ai personnalisé le chemin d'accès à l'API dans application.yml:

springdoc:
  swagger-ui:
    path: /swagger-ui.html

Lorsque je lance l'application et que je vais à http: // localhost: 8080/swagger-ui.html , il me redirige vers http: // localhost: 8080/webjars/swagger-ui /index.html?configUrl=/v3/api-docs/swagger-config . Dans cette page, j'ai une erreur:

Whitelabel Error Page
This application has no configured error view, so you are seeing this as a fallback.
Mon Jan 20 05:16:10 UTC 2020
[7192d9dc] There was an unexpected error (type=Not Found, status=404).
No matching handler

La question est: Dois-je ajouter des configurations supplémentaires à mon application pour afficher la documentation de l'API?

PS: j'utilise spring.boot 2.2.2: RELEASE

javaspringspring-bootspringdoc
8
Seydazimov Nurbol

Par défaut, il vous suffit d'ajouter la dépendance du springdoc-openapi-webflux-ui.

 <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-webflux-ui</artifactId>
      <version>1.2.32</version>
   </dependency>

Vous pouvez consulter le code de démonstration:

Vous pouvez vérifier votre chemin de classe et essayer d'exécuter l'application depuis l'extérieur de l'EDI. Assurez-vous que vous avez les bons paramètres de votre IDE en fonction de vos outils de construction:

Vérifiez également si vous utilisez @EnableWebFlux.

Comme indiqué dans la documentation de référence de Spring Boot, lorsque vous utilisez @EnableWebFlux, vous indiquez à Spring Boot que vous souhaitez prendre le contrôle total de la configuration WebFlux et désactiver toute configuration automatique pour cela (y compris les ressources statiques):

Vous avez deux solutions:

  1. Supprimer @EnableWebFlux
  2. Si vous voulez vraiment prendre le contrôle de la création de Bean et que vous voulez absolument utiliser @EnableWebFlux, alors vous devez ajouter une implémentation de WebFluxConfigurer.

Cela a été discuté ici:

2
ouled saber