logo
  • Proces
  • Case studies
  • Blog
  • O nas
Napisz do nas
  1. Strona główna

  2. /

    Blog

  3. /

    RESTful

RESTful

2 minuty czytania

Tomasz Kozon

API, które określamy mianem RESTful, spełniają określone kryteria, takie jak używanie HTTP jako podstawowego sposobu komunikacji oraz posiadanie struktury i zasobów, które można odwoływać się przez adresy URL.

Spis treści

Jak wygląda zapytanie typu REST do API

Praktyczne wskazówki RESTful

Konstrukcja URL w RESTful API

Zwracane kody odpowiedzi

Restful

Ostatnie oferty pracy

CTO - React/Next.js and Python/Node

B2B:

15000 - 25000 PLN netto +VAT

FullStack Developer ( Node.js + Vue.js/React.js)

UOP:

8000 - 14000 PLN brutto

B2B:

13000 - 20000 PLN netto +VAT

Pokaż wszystkie oferty

Powiązane case studies

PolandBuild

Web development

Pokaż wszystkie case study

RESTful oznacza, że dane API jest w pełni zgodne ze standardem REST. Standard wytwarzania oprogramowania REST odnosi się w szczególności do stron internetowych. Aby można było stwierdzić, że napisane przez nas API spełnia standardy REST musi w praktyce spełniać poniższe wymagania:

  • Unikalne metody za pomocą których odpytuje API takie jak GET, PUT, DELETE, PATCH określane jako ujednolicony interfejs
  • Dane zapytanie jest niezależne od stanu aplikacji, zawsze zwraca to samo, czyli jeżeli zapytamy o zasób o ID=1 w API to niezależnie od tego czy jesteśmy użytkownikiem A czy B powinniśmy uzyskać to samo
  • API zwraca komunikaty o tym czy dane zapytanie odniosło sukces czy też zwróciło błąd. API powinno wskazać dokładnie co to był za błąd.
  • Zapytanie do API powinno jednoznacznie określać jaki rodzaj zasobu odpytuje i dla odpytywania książek będziemy używać innego
  • Klient nie wchodzi bezpośrednio w żadną interakcję z zasobami serwera
  • Możliwość używania cache. API musi zwracać informację czy dany zasób jest zachowany i czy może być zachowany

 

Warto pamiętać, że REST to nie to samo co HTTP, a także REST nie narzuca w żaden sposób typu danych które są zwracane z API. Może to być zarówno JSON jak i zwykły tekst.

Restful API

Jak wygląda zapytanie typu REST do API

Każde zapytanie API powinno posiadać następujące elementy:

  • Nazwę endpointu
  • Rodzaj metody
  • Nagłówki
  • Dane

 

Przykładowym zapytaniem typu GET będzie

curl -H "Authorization: OAuth <ACCESS_TOKEN>" http://www.example.com/users/2

Praktyczne wskazówki RESTful

Wiele jest ogólników dotyczących RESTful API, ale ciężko znaleźć dobre materiały, które by wskazywały co zrobić by w rzeczywistości nasze API spełniało standardy REST.

 

Konstrukcja URL w RESTful API

Jedną z najważniejszych rzeczy jest konstrukcja URLa. Url powinien mieć:

  • korzystamy tylko z małych liter
  • wykorzystujemy myślnik ( - ) zamiast podkreślenia ( _ )
  • nie dodajemy typu zwracanych danych do naszego urla, zamiast tego powinno się wykorzystywać Content-Type w headerze
  • wykorzystujemy liczbę mnogą w nazwie dla nazw kolekcji np /books/
  • wykorzystujemy liczbę pojedyncza dla nazw dokumentów np /books/sciencefiction/
  • nie wykorzystujemy metody typu create, delete w nazwie np. błędem jest zrobienie /deletebook/
  • możemy wersjonować i powinniśmy dodawać główną wersję api do nazwy np. /v1/books/

 

Zwracane kody odpowiedzi

API powinno zwracać kody odpowiedzi. Standardem są odpowiedzi zawierające kody błędów o numerach od 2xx, 3xx, 4xx, 5xx. Wszystkie poza odpowiedziami z grupy 200 oznaczają, że w naszym API wystąpił jakiś błąd.

Powiązane artykuły

Porównanie sposobów komunikacji między aplikacją frontendową REST vs GraphQL

23 cze 2023

Artykuł poświęcony będzie porównaniu dwóch popularnych sposobów komunikacji między aplikacją frontendową a backendem - REST i GraphQL. Porównamy ich wady i zalety, zwracając szczególną uwagę na sposoby przesyłania danych oraz dostępność dla programistów. Czy warto wybrać GraphQL zamiast REST? Odpowiedź znajdziesz w naszym artykule.

Sebastian Świtoń

#front-end

related-article-image-null

Jam Stack – przełom czy dobrze znana technologia?

17 lut 2022

Jam Stack to technologia, która polega na budowaniu aplikacji internetowych za pomocą statycznie generowanych stron, które są hostowane na serwerach CDN. Jest coraz bardziej popularny wśród programistów, ponieważ oferuje wiele korzyści, takich jak szybkość, niskie koszty utrzymania i bezpieczeństwo.

Tomasz Kozon

#front-end

Optymalizacja obrazów Dockera

24 lip 2023

Obrazy dla kontenerów Dockera mogą być naprawdę ciężkie. W internecie można znaleźć przykłady image'ów ważących nawet po 5 lub więcej gigabajtów. Jest to problem, zarówno dla developerów, używających Dockera do lokalnego developmentu, jak i dla osób odpowiedzialnych za setup aplikacji w środowiskach testowych i produkcyjnych. W artykule zostanie poruszony temat zmniejszania rozmiaru obrazów Dockera.

Dawid Kruk

#devops

Customowe template tags w Django

13 lip 2023

Template tags to świetne narzędzie pozwalające na manipulację danymi z poziomu template'ów w aplikacjach opartych o framework Django. Dużo z nich jest już wbudowanych we framework i gotowych do użytku, jednak czasem potrzebna jest customowa funkcjonalność.

Dawid Kruk

#fullstack

InVision Studio - niezbędne narzędzie dla każdego projektanta UI/UX

25 wrz 2023

InVision Studio to narzędzie, którego każdy projektant UI/UX powinien mieć w swoim arsenale. Pomaga w tworzeniu responsywnych interfejsów, prototypów i animacji, umożliwiając szybką i efektywną pracę. Doceniany za innowacyjność, łatwość obsługi oraz szeroki zakres funkcji, InVision Studio silnie zaznacza swoją obecność w świecie projektowania UI/UX.

Tomasz Kozon

#web-design

Efektywne prowadzenie webinarów w sektorze IT

25 wrz 2023

W dobie cyfryzacji, webinar staje się jednym z najważniejszych narzędzi w sektorze IT. Powodzenie webinaru zależy od wielu czynników, począwszy od przygotowania, a skończywszy na umiejętności utrzymania zaangażowania uczestników. Zatem cyfrowym szlakiem: poradnik efektywnego prowadzenia, to przewodnik, który pomoże przetrwać w cyfrowym świecie webinarów IT. Dowiedz się więcej, jak skutecznie zorganizować i przeprowadzić webinar, a swoje zdobycze wiedzy zastosować w praktyce.

Tomasz Kozon

#product-management

MyISAM - mechanizm składowania danych w MySQL

25 wrz 2023

MyISAM, zasłużony odpowiednik MySQL dla architektury składowania danych, to prawdziwy klejnot w jego koronie. Zapewniając szybką indeksację i wysoki poziom skompresowanych danych, MyISAM umożliwia efektywne zarządzanie dużymi ilościami informacji. Weźmy zestaw narzędzi, aby zgłębić tajemnice tego mechanizmu składowania danych.

Tomasz Kozon

Zobacz wszystkie artykuły

Napisz do nas

hello@boringowl.io

Zadzwoń

+48 509 280 539

Znajdź nas

Newsletter
social iconsocial iconsocial iconsocial iconsocial icon
logo

Oferta

  • Web Development

  • Mobile Development

  • UI/UX Design

  • E-commerce

  • Team Extension

  • Body Leasing

Menu

  • O nas

  • Case studies

  • FAQ

  • Blog

  • Kariera

  • Kontakt

© 2023 - Boring Owl - Software House Warszawa

adobexd

adobexd

algolia

algolia

amazon-s3

amazon-s3

android

android

angular

angular

api

api

apscheduler

apscheduler

aws-amplify

aws-amplify

aws-lambda

aws-lambda

axios

axios

bash

bash

bootstrap

bootstrap

bulma

bulma

cakephp

cakephp

celery

celery

chartjs

chartjs

clojure

clojure

cloudinary

cloudinary

cms

cms

cobol

cobol

contentful

contentful

cpython

cpython

css3

css3

django

django

django-rest

django-rest

docker

docker

drupal

drupal

dynamodb

dynamodb

electron

electron

expo-io

expo-io

express-js

express-js

fakerjs

fakerjs

fastapi

fastapi

fastify

fastify

figma

figma

firebase

firebase

flask

flask

flutter

flutter

gatsbyjs

gatsbyjs

ghost-cms

ghost-cms

google-cloud

google-cloud

graphcms

graphcms

graphql

graphql

groovy

groovy

gulpjs

gulpjs

hasura

hasura

headless-cms

headless-cms

heroku

heroku

html5

html5

httpie

httpie

immutablejs

immutablejs

ios

ios

java

java

javascript

javascript

jekyll

jekyll

jekyll-admin

jekyll-admin

jenkins

jenkins

jquery

jquery

json

json

keras

keras

keystone5

keystone5

kotlin

kotlin

kubernetes

kubernetes

laravel

laravel

lodash

lodash

magento

magento

mailchimp

mailchimp

material-ui

material-ui

matlab

matlab

maven

maven

miro

miro

mockup

mockup

momentjs

momentjs

mongodb

mongodb

mysql

mysql

nestjs

nestjs

net

net

netlify

netlify

next-js

next-js

nodejs

nodejs

npm

npm

nuxtjs

nuxtjs

oracle

oracle

pandas

pandas

php

php

postgresql

postgresql

postman

postman

prestashop

prestashop

prettier

prettier

prisma

prisma

prismic

prismic

prose

prose

pwa

pwa

python

python

python-scheduler

python-scheduler

rabbitmq

rabbitmq

react-js

react-js

react-native

react-native

react-static

react-static

redis

redis

redux

redux

redux-saga

redux-saga

redux-thunk

redux-thunk

restful

restful

ruby-on-rails

ruby-on-rails

rust

rust

rxjs

rxjs

saleor

saleor

sanity

sanity

scala

scala

scikit-learn

scikit-learn

scrapy

scrapy

scrum

scrum

selenium

selenium

sentry

sentry

shodan

shodan

slack

slack

sms-api

sms-api

socket-io

socket-io

solidity

solidity

spring

spring

sql

sql

sql-alchemy

sql-alchemy

storyblok

storyblok

storybook

storybook

strapi

strapi

stripe

stripe

structured-data

structured-data

struts

struts

svelte

svelte

swagger

swagger

swift

swift

symfony

symfony

tensorflow

tensorflow

terraform

terraform

threejs

threejs

twig

twig

typescript

typescript

vercel

vercel

vue-js

vue-js

webpack

webpack

websocket

websocket

woocommerce

woocommerce

wordpress

wordpress

yarn

yarn

yii

yii

zend

zend

zeplin

zeplin

Zobacz więcej