sampo-dev / Saara_harjottelee

Harjoittelualusta
0 stars 0 forks source link

Make REST-api version of fetching MP names from Eduskunta interface #7

Open Sampax opened 4 days ago

Sampax commented 4 days ago

Preliinary work in #2

Eduskunta api Swagger docs here: https://avoindata.eduskunta.fi/swagger/apidocs.html

saarashikeben commented 2 days ago

What is Swagger (now known as OpenAPI)?

Swagger is a set of tools for designing, building, and documenting web APIs.

It helps developers understand how to use an API without needing to read through pages of text. It works like a detailed map of the API, showing all the roads (endpoints) and what you'll find at each destination (data).

You can often test API calls right in your browser (I need to find out what that means a bit later!)

Swagger docs usually looks like a web page with a list of all API endpoints. Each endpoint has details about what it does, what data it needs, and what it returns. (Sometimes includes a "Try it out" button to test the API directly.)

For API creators: It helps them design and document their APIs clearly. For API users: It makes learning and using new APIs easier.