REST Canvas

Suunnittele sovellusrajapinnat RESTful-periaatteiden mukaisesti määrittelemällä resurssit, verbit sekä esimerkkipyynnöt ja -vastaukset.

Tulokset

• Johdonmukainen RESTful API-suunnittelu

Näin se toimii

SVG | PNG | JSON

Vaiheet

1. Tunnista APIn tarjoamat keskeiset resurssit
2. API-resurssimallin rakenteen määrittäminen
3. Määritä HTTP-verbit, joita käytetään vuorovaikutuksessa resurssien kanssa.
4. Anna esimerkkipyynnöt ja -vastaukset kullekin verbille

Vinkki

• Käytä tavallisia HTTP-menetelmiä (GET, POST, PUT, DELETE).
• Varmistetaan, että resurssien URI:t ovat intuitiivisia ja johdonmukaisia.
• asiakirjan virheiden käsittely ja vastauskoodit