BAEL-3493: Spring REST Docs vs OpenAPI (#9295)

2020-05-16 02:07:36 +05:30
parent b707c20297
commit 708e85ce38
11 changed files with 672 additions and 2 deletions
@@ -0,0 +1,28 @@
+package com.baeldung.restdocopenapi;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+
+@SpringBootApplication()
+public class Application {
+
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+    @Bean
+    public OpenAPI customOpenAPI(@Value("${springdoc.version}") String appVersion) {
+        return new OpenAPI().info(new Info().title("Foobar API")
+            .version(appVersion)
+            .description("This is a sample Foobar server created using springdocs - a library for OpenAPI 3 with spring boot.")
+            .termsOfService("http://swagger.io/terms/")
+            .license(new License().name("Apache 2.0")
+                .url("http://springdoc.org")));
+    }
+}
@@ -0,0 +1,93 @@
+package com.baeldung.restdocopenapi;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+
+@Entity
+public class Foo {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false)
+    private String title;
+    
+    @Column()
+    private String body;
+
+
+    protected Foo() {
+    }
+
+    public Foo(long id, String title, String body) {
+        this.id = id;
+        this.title = title;
+        this.body = body;
+    }
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public String getBody() {
+        return body;
+    }
+
+    public void setBody(String body) {
+        this.body = body;
+    }
+
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result;
+        result = prime * result + ((id == null) ? 0 : id.hashCode());
+        result = prime * result + ((title == null) ? 0 : title.hashCode());
+        return result;
+    }
+    
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj)
+            return true;
+        if (obj == null)
+            return false;
+        if (getClass() != obj.getClass())
+            return false;
+        Foo other = (Foo) obj;
+        if (id == null) {
+            if (other.id != null)
+                return false;
+        } else if (!id.equals(other.id))
+            return false;
+        if (title == null) {
+            if (other.title != null)
+                return false;
+        } else if (!title.equals(other.title))
+            return false;
+        return true;
+    }
+    
+    @Override
+    public String toString() {
+        return "Foo [id=" + id + ", title=" + title + "]";
+    }
+}
@@ -0,0 +1,83 @@
+package com.baeldung.restdocopenapi;
+
+import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.linkTo;
+
+import java.util.List;
+import java.util.Optional;
+
+import javax.validation.Valid;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/foo")
+public class FooController {
+
+    @Autowired
+    FooRepository repository;
+
+    @GetMapping
+    public ResponseEntity<List<Foo>> getAllFoos() {
+        List<Foo> fooList = (List<Foo>) repository.findAll();
+        if (fooList.isEmpty()) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+        return new ResponseEntity<>(fooList, HttpStatus.OK);
+    }
+
+    @GetMapping(value = "{id}")
+    public ResponseEntity<Foo> getFooById(@PathVariable("id") Long id) {
+
+        Optional<Foo> foo = repository.findById(id);
+        return foo.isPresent() ? new ResponseEntity<>(foo.get(), HttpStatus.OK) : new ResponseEntity<>(HttpStatus.NOT_FOUND);
+    }
+
+    @PostMapping
+    public ResponseEntity<Foo> addFoo(@RequestBody @Valid Foo foo) {
+        HttpHeaders httpHeaders = new HttpHeaders();
+        httpHeaders.setLocation(linkTo(FooController.class).slash(foo.getId())
+            .toUri());
+        Foo savedFoo;
+        try {
+            savedFoo = repository.save(foo);
+        } catch (Exception e) {
+            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+        }
+
+        return new ResponseEntity<>(savedFoo, httpHeaders, HttpStatus.CREATED);
+    }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Void> deleteFoo(@PathVariable("id") long id) {
+        try {
+            repository.deleteById(id);
+        } catch (Exception e) {
+            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+        }
+        return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+    }
+
+    @PutMapping("/{id}")
+    public ResponseEntity<Foo> updateFoo(@PathVariable("id") long id, @RequestBody Foo foo) {
+        boolean isFooPresent = repository.existsById(Long.valueOf(id));
+
+        if (!isFooPresent) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+
+        Foo updatedFoo = repository.save(foo);
+
+        return new ResponseEntity<>(updatedFoo, HttpStatus.OK);
+    }
+}
@@ -0,0 +1,9 @@
+package com.baeldung.restdocopenapi;
+
+import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface FooRepository extends PagingAndSortingRepository<Foo, Long>{
+
+}
@@ -0,0 +1,121 @@
+package com.baeldung.restdocopenapi.springdoc;
+
+import static org.springframework.hateoas.server.mvc.WebMvcLinkBuilder.linkTo;
+
+import java.util.List;
+import java.util.Optional;
+
+import javax.validation.Valid;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.restdocopenapi.Foo;
+import com.baeldung.restdocopenapi.FooRepository;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+@RestController
+@RequestMapping("/foobar")
+@Tag(name = "foobar", description = "the foobar API with documentation annotations")
+public class FooBarController {
+
+    @Autowired
+    FooRepository repository;
+
+    @Operation(summary = "Get all foos")
+    @ApiResponses(value = { 
+            @ApiResponse(responseCode = "200", description = "found foos", content = { 
+                @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = Foo.class)))}), 
+            @ApiResponse(responseCode = "404", description = "No Foos found", content = @Content) })
+    @GetMapping
+    public ResponseEntity<List<Foo>> getAllFoos() {
+        List<Foo> fooList = (List<Foo>) repository.findAll();
+        if (fooList.isEmpty()) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+        return new ResponseEntity<>(fooList, HttpStatus.OK);
+    }
+
+    @Operation(summary = "Get a foo by foo id")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "found the foo", content = { 
+                    @Content(mediaType = "application/json", schema = @Schema(implementation = Foo.class))}),
+            @ApiResponse(responseCode = "400", description = "Invalid id supplied", content = @Content), 
+            @ApiResponse(responseCode = "404", description = "Foo not found", content = @Content) })
+    @GetMapping(value = "{id}")
+    public ResponseEntity<Foo> getFooById(@Parameter(description = "id of foo to be searched") @PathVariable("id") String id) {
+
+        Optional<Foo> foo = repository.findById(Long.valueOf(id));
+        return foo.isPresent() ? new ResponseEntity<>(foo.get(), HttpStatus.OK) : new ResponseEntity<>(HttpStatus.NOT_FOUND);
+    }
+
+    @Operation(summary = "Create a foo")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "201", description = "foo created", content = { @
+                    Content(mediaType = "application/json", schema = @Schema(implementation = Foo.class))}),
+            @ApiResponse(responseCode = "404", description = "Bad request", content = @Content) })
+    @PostMapping
+    public ResponseEntity<Foo> addFoo(@Parameter(description = "foo object to be created") @RequestBody @Valid Foo foo) {
+        HttpHeaders httpHeaders = new HttpHeaders();
+        httpHeaders.setLocation(linkTo(FooBarController.class).slash(foo.getId()).toUri());
+        Foo savedFoo;
+        try {
+            savedFoo = repository.save(foo);
+        } catch (Exception e) {
+            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+        }
+
+        return new ResponseEntity<>(savedFoo, httpHeaders, HttpStatus.CREATED);
+    }
+
+    @Operation(summary = "Delete a foo")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "204", description = "foo deleted"),
+            @ApiResponse(responseCode = "404", description = "Bad request", content = @Content) })
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Void> deleteFoo(@Parameter(description = "id of foo to be deleted") @PathVariable("id") long id) {
+        try {
+            repository.deleteById(id);
+        } catch (Exception e) {
+            return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+        }
+        return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+    }
+
+    @Operation(summary = "Update a foo")
+    @ApiResponses(value = {
+            @ApiResponse(responseCode = "200", description = "foo updated successfully", content = {
+                    @Content(mediaType = "application/json", schema = @Schema(implementation = Foo.class))}),
+            @ApiResponse(responseCode = "404", description = "No Foo exists with given id", content = @Content) })
+    @PutMapping("/{id}")
+    public ResponseEntity<Foo> updateFoo(@Parameter(description = "id of foo to be updated") @PathVariable("id") long id, @RequestBody Foo foo) {
+        
+        boolean isFooPresent = repository.existsById(Long.valueOf(id));
+
+        if (!isFooPresent) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+        
+        Foo updatedFoo = repository.save(foo);
+
+        return new ResponseEntity<>(updatedFoo, HttpStatus.OK);
+    }
+}