Simple REST-APIs with Dropwizard and Swagger. Bernd Schönbach LeanIX GmbH

Transcription

1 Simple REST-APIs with Dropwizard and Swagger Bernd Schönbach LeanIX GmbH

2 Motivation Quickly create REST-APIs Make it testable Deploy with a click Or even better automatically Provide Documentation without MS Office Provide SDK with no extra action needed 2

3 Agenda Introduction About me About LeanIX Dropwizard Set Up / Basic Features Demo Swagger + Swagger UI Set Up / Basic Features Demo 3

4 Agenda Introduction About me About LeanIX Dropwizard Set Up / Basic Features Demo Swagger + Swagger UI Set Up / Basic Features Demo 4

5 About me Bernd Schönbach Environment Est.: 1982 First Language: PHP (2001) Second Language: Java (2010)

6 IT Architectures are more important than ever before Shorter time to market Real-time big data insights Efficient scalability Exceptional user experience Consistent channels Integrated workflows More APIs Devices Sensors 6

7 LeanIX is the most comfortable solution as SaaS Available Integrations 7

8 Well-known brands of all industries trust in LeanIX Industrials & Manufacturing Financial & Insurance Consumer Energy & Materials Pharma Media Telecoms Travel Logistics INTERNATIONAL EXPANSION 8

9 LeanIX is based on a modern Microservices Stack Single Page App Angular (2) Typescript Pathfinder UI Backend Services GraphQL or REST API oauth2 /w JWT Swagger API Docs Event-Bus (Webhooks) Pathfinder Webhooks MTM Export Images Survey Metrics Resources No sharing across services Deployment with Docker Postgres Elasticsearch ArangoDB Kafka Postgres Postgres Shibboleth PhantomJS Postgres Elasticsearch InfluxDB Platform Services 9

10 Agenda Introduction About me About LeanIX Dropwizard Set Up / Basic Features Demo Swagger + Swagger UI Set Up / Basic Features Demo 10

11 Dropwizard Overview Java Framework for RESTful Web Services Quick Startup (few seconds) Completely configurable Current Version: (we will be using 1.1.1) Live Demo 11

12 Dropwizard Overview Framework Contents: Jetty for HTTP Jersey for REST Jackson for JSON transformation Hibernate for DB Access Other usefull inclusions Metrics Liquibase Slf4j and Logback and much more... Live Demo 12

13 Dropwizard First Steps: Create Maven Project Add dependency to dropwizard Configure Maven Shade Plugin Add configuration file (optional) Start coding 13

14 Dropwizard Add dependency to pom.xml Standard way (dropwizard only) Step 1: <properties> <dropwizard.version>1.1.2</dropwizard.version> </properties> Step 2: <dependencies> <dependency> <groupid>io.dropwizard</groupid> <artifactid>dropwizard-core</artifactid> <version>${dropwizard.version}</version> </dependency> </dependencies> 14

15 Dropwizard Add dependency to pom.xml Our way (Swagger & Dropwizard together) Step 1: <properties> <dropwizard.version> </dropwizard.version> </properties> Step 2: <dependencies> <dependency> <groupid>com.smoketurner</groupid> <artifactid>dropwizard-swagger</artifactid> <version>${dropwizard.version} </version> </dependency> </dependencies> 15

16 Dropwizard Configure Maven Shade Plugin <plugin> <artifactid>maven-shade-plugin</artifactid> <version>2.4.1</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration combine.children="append"> <createdependencyreducedpom> true </createdependencyreducedpom> <outputfile>target/froscon-test.jar</outputfile> [...] </configuration> </execution> </executions> </plugin> 16

17 Let s code!

18 Dropwizard Configure your Application config.yml server: applicationconnectors: type: http port: 1337 adminconnectors: type: http port: $env:admin_port:1338 Logging: level: INFO FooBar: Value 18

19 Dropwizard Resource Methods and persons ) public class PersonResource public String getpersons() {[ public String updateperson() {[ public String createperson() {[ public String deleteperson() {[ ]} URL: URL: public String getpersonaddress() {[ ]} 19

20 Dropwizard Query and Path Params Task 1: Search an Entity. URL: Query Parameters public class PersonResource public String name ) String name ) {[ ]} Task 2: Retrieve an Entity: URL: Path Parameters public class {id} ) public String id ) String id ) {[ ]} 20

21 Dropwizard Response Types Return and public class PersonResource public String getperson name ) String name ) xml public String getpersonxml () { [ ] } 21

22 Dropwizard - HATEOAS - Validators and Defaults for Query Parameters - Authentication Handling 22

23 Dropwizard Pimping your Response (HATEOAS) - Add Meta Information to Response Data - Provide Links to allow automated traversal (by machines) { data: [{ },,{ }] size: 10 total: 150 links: { next: /persons/page=2&limit=10, current: /persons/page=1&limit=10, previous: null } } 23

24 Dropwizard Pimping your Response (HATEOAS) Response Objects public class BasicResponse { protected ResponseStatus status = ResponseStatus.OK; protected String type; protected String message; protected Long total; [ ] } public class PersonResponse extends BasicResponse { protected Person data; protected Links links; public class Links { protected String next; protected String previous; protected String current; } } 24

25 Dropwizard Pimping your Response (HATEOAS) Option B: Jersey Links - Add dependency to jersey-server-linking - Register in run function of App.java - Annotations App.java public void run(appconfig conf, Environment env) throws Ex { environment.jersey().getresourceconfig().packages(getclass().getpackage().getname()).register(declarativelinkingfeature.class); } For further Information see: 25

26 Dropwizard Validators and Defaults for Query Parameters Validating: public class PersonResource public String getperson name ) name String name ) {[ ]} Supplied by = Integer, max @Pattern(regex= 26

27 Dropwizard Authentication Handling Step 1: Create Authentication Provider: public class ExampleAuthenticator implements Authenticator<BasicCredentials, User> public Optional<User> authenticate( BasicCredentials credentials ) throws AuthenticationException { if ("secret".equals(credentials.getpassword())) { return Optional.of(new User(credentials.getUsername())); } return Optional.absent(); } } 27

28 Dropwizard Authentication Handling Step 2: Register Authentication Provider: public void run(appconfig conf, Environment env) throws Ex { environment.jersey().register( new AuthDynamicFeature( new BasicCredentialAuthFilter.Builder<User>().setAuthenticator(new ExampleAuthenticator()).setRealm("SUPER SECRET STUFF").buildAuthFilter() ) ); environment.jersey().register( RolesAllowedDynamicFeature.class ); environment.jersey().register( new AuthValueFactoryProvider.Binder<>(User.class) ); } 28

29 Dropwizard Authentication Handling Step 3: Use Auth Parameter: public class PersonResource public String getperson name String User auth ) { [ ] } } 29

30 Agenda Introduction About me About LeanIX Dropwizard Set Up / Basic Features Demo Swagger + Swagger UI Set Up / Basic Features Demo 30

31 Swagger Swagger + Swagger UI - Simple documentation for REST APIs - Allows automatic SDK Generation - Nice and interactive User Interface 31

32 32

33 Swagger Workflow Code Annotation JSON Specification HTML API UI SDK Generation 33

34 Let s code!

35 Swagger Basic @ApiOperation( value = String, notes = String, response = Class, responsecontainer = 35

36 Swagger Basic name = String, value = String, defaultvalue = String, required = Boolean, allowablevalues = String, example= String, hidden = Boolean ) 36

37 Swagger Further value= String, description= String value = String, allowablevalues= 37

38 Swagger SDK Generation Example for PHP and Java: Configuration for that: Live Demo 38

39 Questions?

40 Thank you!

41 Sources Dropwizard: Swagger: Swagger-UI: Hibernate Validator: Dropwizard Swagger Package:

42 Slides will be available at Slideshare: