API design

Torsdag den 17:e januari 2019

Lektionsplan

Lektion från kl. 8:30 till kl. 16:00

1. Sammanfattning av senaste lektion (Arkitektur, URL och REST)
2. Genomgång av dagens ämne (API design)
3. Quiz
4. Genomgång av övning till idag.
5. 11:30 Projekt 1 avslutning
6. 13:00 Projekt 2 start

Kurslitteratur

Pull request

• The Art of Humanizing Pull Requests

OpenAPI och Swager

• Intro to Swagger – A Structured Approach to Creating an API

API design

• An Introduction to APIs For the Uninitiated
• Understanding the API-First Approach to Building Products
• Three Principles of API First Design

Extra kurslitteratur

Detta är inspiration till material man kan läsa för att öka chansen för VG.

• Key Lessons From 100 API Projects

OpenAPI / Swagger

• OpenAPI Specification
• Basic Structure
• Adding Examples

Api first

• The Three Principles of Excellent API Design
• Understanding API First Design

API design

• Gratis e-bok: Web API Design - Crafting Interfaces that Developers Love

Övningar

I tabellen under ses ett REST API till att tillgå hundraser, beskriv detta API med OpenApi i systemet SwaggerHub, du kommer att behöva en konto, du kommer även att skulle använda detta verktyg i projekt 2.

Getting Started With SwaggerHub

När du är klar med APIet i SwaggerHub, är det möjligt få ett API endpoint (en url), testa detta endpoint med med programmet Postman.

Projekt

Avslutning projekt 1 med Pull Request

Start projekt 2 Länk till Github classroom to be anounced

Extra

NSwag

Är en rad av .NET verktyg för OpenAPI NSwag GitHub

Generera Controllers med för ASP.NET core https://github.com/RSuter/NSwag/wiki/SwaggerToCSharpControllerGenerator

Varför lägger vi kod i ett class liberary https://softwareengineering.stackexchange.com/questions/117461/when-should-a-class-or-module-be-in-a-separate-assembly-dll