Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
devel:documentation:architecture:dev:swagger [2023/10/19 10:43]
chalupat [#3330] Replace Springfox with springdoc
devel:documentation:architecture:dev:swagger [2023/10/19 10:46] (current)
chalupat [#3330] Replace Springfox with springdoc 2
Line 392: Line 392:
   * Use ''produces = BaseController.APPLICATION\_HAL\_JSON\_VALUE'' in controller mapping   * Use ''produces = BaseController.APPLICATION\_HAL\_JSON\_VALUE'' in controller mapping
   * Use ''@ApiOperation(nickname = "<operatonId>")'' e.g. ''@ApiOperation(nickname = "ping")'' for controller methods - nickname (=> operationId) can be used in permalink.    * Use ''@ApiOperation(nickname = "<operatonId>")'' e.g. ''@ApiOperation(nickname = "ping")'' for controller methods - nickname (=> operationId) can be used in permalink. 
 +
 +in springdoc version (13.1.0+)
 +  * Add Swagger annotation. What can be written into annotation, will be written to annotation - will be shown in dynamic and static documentation. Static documentation extension is used, when annotation doesn't fit.
 +  * Use module-<module>.properties with ''PropertyModuleDescriptor''.
 +  * ''produces = BaseController.APPLICATION\_HAL\_JSON\_VALUE'' is set by default but you can override it
 +  * Use ''@Operation(operationId= "<operatonId>")'' e.g. ''@Operation(operationId= "ping")'' for controller methods can be used in permalink. 
  
 ===== Aggregator ===== ===== Aggregator =====
  • by chalupat