Innan du sätter igång med detta, läs igenom: Utveckling
Där har vi författat viktiga saker att känna till som systemutvecklare på Sundsvalls Kommun.
...
Lägg till följande i pom:en för att exponera swagger-ui:
| Code Block | ||
|---|---|---|
| ||
<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.6.4</version> </dependency> |
...
Skapa en klass för att snygga till OpenAPI-infoinfon (Inte nödvändigt):
| Code Block | ||
|---|---|---|
| ||
package se.sundsvall.demo;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class OpenApiConfig {
@Bean
OpenAPI openApi() {
return new OpenAPI()
.info(new Info().title("Demo Application")
.version("1.0.0")
.description("Description")
.contact(new Contact().name("Contact Name")
.email("noreply@sundsvall.se")
.url("https://sundsvall.se")));
}
} |
Skapa även en enkel controllerController-klass för att ha någonting att anropa:
| Code Block | ||
|---|---|---|
| ||
package se.sundsvall.demo;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(value = "/demo")
public class DemoResource {
@GetMapping(value = "/helloThere")
public ResponseEntity<String> helloThere() {
return ResponseEntity.ok("General Kenobi!");
}
} |
För att starta applikationen kör: mvn spring-boot:run. Navigera sedan till http://localhost:8080/swagger-ui/index.html för att testa ditt API.