Automatic generate Swagger documentation from Java

Question

I have this REST service:

@RestController
public class ContaCorrenteController {

    @Autowired
    private configCorrenteService service;

    @Produces(MediaType.APPLICATION_JSON)
    @RequestMapping("/v1/number/{number}/config/{config}/final/{data}")
    @GET
    public ResponseEntity<Final> Final(
            @PathVariable("number") Integer number, 
            @PathVariable("config") Integer config, 
            @PathVariable("data") @DateTimeFormat(pattern="yyyyMMdd") LocalDate data) {
        Final final = service.consultFinal(number, config, data);
        return ResponseEntity.ok(final);
    }

    @Produces(MediaType.APPLICATION_JSON)
    @RequestMapping("/v1/number/{number}/config/{config}/final")
    @GET
    public ResponseEntity<Final> final(
            @PathVariable("number") Integer number, 
            @PathVariable("config") Integer config) {
        Final final = service.consultFinalNow(number, config);
        return ResponseEntity.ok(final);
    }
}

I need to automatically genarete a REST documentation using this java file. Can I automatically generate a json or yaml to import on Swagger editor or another way to documentation?

Please see here; github.com/swagger-api/swagger-core/wiki/… — Sercan Ozdemir
– Sercan Ozdemir, Commented Aug 31, 2015 at 18:44
Think this will be helpful baeldung.com/swagger-2-documentation-for-spring-rest-api — Valeriy K.
– Valeriy K., Commented Jul 5, 2019 at 12:17

fehguy · Accepted Answer · 2015-09-01 04:12:20Z

4

You can integrate with SpringFox:

https://github.com/springfox/springfox

Which can automatically generate swagger definitions from your Spring-MVC server. You'll need to add some annotations to effectively document things but it should be quite straight forward.

answered Sep 1, 2015 at 4:12

fehguy

6,82427 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Computered Over a year ago

Hi, thank you for your answer... Could you explain what is the difference between Swagger-Core and Springfox? May I use only Swagger-Core to automatic generating the Swagger documentation? Thank you a lot.

fehguy Over a year ago

Springfox is a community-driven project to add swagger support to spring-mvc. Swagger core is focused on pure servlets and JAX-RS

Collectives™ on Stack Overflow

Automatic generate Swagger documentation from Java

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related