In this lecture we will talk a bit more about UML2 and layered archiceture before we move on to look at different types of API’s.

Carsten will show how to use OpenAPI to build a REST API and we will have a visit from Jesper who will show how GraphQL works.

We will also look at a model to determine how mature a REST API is.

Lastly we will start ot look at how to document software.

Tutorial Session

Assignments

Mandatory Reading

• Introduction to Javadoc
• Best Practices in API Design (Read: Good Practices…)
• Richardson Maturity Model
• OpenAPI Specification 3.1.0 (Don’t read it all! Read enough to make you know how to write a specification)
• Swagger Editor (Try to write your own specification of an API)
• Ten simple rules for documenting scientific software

Materials (Slides, etc.)

• Slides will be published after the lecture