À l'aide de la documentation Javadoc pour générer Swagger document

Je veux construire l'Arrogance de la documentation pour un ensemble d'Api RESTful. J'ai la condition suivante:

  1. Générer Swagger Doc en mode hors connexion (j'ai utilisé http://kongchen.github.io/swagger-maven-plugin/). Ce plugin me permet de générer de l'Arrogance de la documentation au cours de la compilation.
  2. La lecture de l'existant Javadoc de sorte qu'ils peuvent être utilisés dans l'Arrogance de la documentation.

Jusqu'à présent en utilisant le plugin ci-dessus, j'ai été en mesure d'atteindre le point n ° 1. Donc, pour un REPOS méthode:

 /**
 * <p>
 * Gets the {@link DisplayPreferenceModel} with the name as provided in the parameter. The preference with the given name defined at the tenant or master level is returned.
 * This API gives us the preference if it is eligible for unauthorized access If it is not eligible it throws an Exception saying Authorization required.
 * </p>
 * @param preferenceName
 *            - The name of the preference.
 * @return {@link DisplayPreferenceModel}
 */
@RequestMapping(method = RequestMethod.GET, value = "/preferences/{preferenceName}")
@ApiOperation(value = "This API gives us the preference if it is eligible for unauthorized access If it is not eligible it throws an Exception saying Authorization required", 
                        notes = "No Notes please", response = DisplayPreferenceModel.class)
@ApiResponses(value = { 
                        @ApiResponse(code = 400, message = "Invalid preferenceName supplied"), 
                        @ApiResponse(code = 404, message = "Display Preference Not Found")
                      }
            )
public DisplayPreferenceModel getDisplayPreference( @PathVariable("preferenceName") final String preferenceName ) {
}

J'ai été en mesure de générer de l'Arrogance de la documentation. L'utilisation de @ApiOperation & @ApiResponses fait ma documentation ressemble beaucoup.

Cependant, ma question est puis-je utiliser la Javadoc au lieu de faire tous les développeurs à créer des @ApiOperation & @ApiResponses de sorte qu'il permet de gagner du temps pour mon équipe?

  • comment générer ce docs @raj? mon projet est basé sur maven j'ai ajouté de l'Api de notation, ApiResonses la notation en tant que bien, mais comment puis-je générer la documentation de l'aide?
  • J'ai utilisé "swagger-spring mvc' v1.0.2. Puis j'ai créé un CustomSwaggerConfig classe qui avait le '@Configuration' & '@EnableSwagger'. Et dans applicationContext.xml j'ai référencé le CustomSwaggerConfig.
  • je n'ai pas le printemps, je suis juste avec maven, struts
  • Désolé mon ami, ne peut pas vous aider beaucoup sur ce. Notre projet utilise le Printemps des bibliothèques et, par conséquent, nous utilisons le "swagger-spring mvc'
InformationsquelleAutor Raj | 2015-09-01