From ac4298bde842231b32c4dc96528df6301c62fc7a Mon Sep 17 00:00:00 2001 From: Gabriel Almeida Bueno Date: Fri, 28 Mar 2025 17:10:21 -0300 Subject: [PATCH] endpoints_2 --- .../src/css/vars.css | 12 +- .../src/routes/endpoints_1/+page.svelte | 12 +- .../src/routes/endpoints_2/+page.svelte | 127 +++++++++++++++++- .../src/routes/projeto_de_api/+page.svelte | 2 +- 4 files changed, 136 insertions(+), 17 deletions(-) diff --git a/material-sistemas-distribuidos/src/css/vars.css b/material-sistemas-distribuidos/src/css/vars.css index 7121baa..3e1939c 100644 --- a/material-sistemas-distribuidos/src/css/vars.css +++ b/material-sistemas-distribuidos/src/css/vars.css @@ -1,21 +1,21 @@ :root { /* light theme */ /* --color-bg: #e0e0e0; */ - --color-bg: #fff5ee; + --color-bg: #fefefe; --color-fg: #1c1c1c; --color-anchor-bg: unset; --color-anchor-fg: black; - --color-kbd-bg: beige; + --color-kbd-bg: #f9f9f9; --color-kbd-fg: var(--color-fg); --color-kbd-border: lightgray; - --color-codeblock-bg: beige; + --color-codeblock-bg: #f9f9f9; --color-codeblock-fg: var(--color-fg); --color-codeblock-border: lightgray; - --color-code-bg: beige; + --color-code-bg: #f9f9f9; --color-code-fg: var(--color-fg); --color-code-border: lightgray; @@ -36,8 +36,8 @@ --paragraph-size: 18px; --paragraph-spacing: 18px; - --article-width: 1000px; + --article-width: 950px; --article-font-size: 18px; - --article-line-height: 1.8em; + --article-line-height: 1.9em; --article-spacing: 16px; } \ No newline at end of file diff --git a/material-sistemas-distribuidos/src/routes/endpoints_1/+page.svelte b/material-sistemas-distribuidos/src/routes/endpoints_1/+page.svelte index ef4347a..9f7c2fe 100644 --- a/material-sistemas-distribuidos/src/routes/endpoints_1/+page.svelte +++ b/material-sistemas-distribuidos/src/routes/endpoints_1/+page.svelte @@ -8,6 +8,10 @@ import BrowserNetwork from "../../assets/img/43_browser_network.png"; + + Criando e executando endpoints + +

Criando e executando endpoints

@@ -16,12 +20,8 @@

- Enfim, vamos escrever nossos primeiros endpoints. -

- -

- Durante este capitulo, vamos trabalhar somente em Biblioteca/Program.cs. Nosso objetivo por enquanto é escrever um endpoint customizado, e testar se ele - responde corretamente, da forma como desejamos. + Neste capítulo, vamos escrever o nosso primeiro endpoint. Iremos trabalhar somente no arquivo Biblioteca/Program.cs. Nosso objetivo por enquanto é escrever um endpoint, e testar se ele + responde corretamente.

diff --git a/material-sistemas-distribuidos/src/routes/endpoints_2/+page.svelte b/material-sistemas-distribuidos/src/routes/endpoints_2/+page.svelte index 1f7108a..c30114f 100644 --- a/material-sistemas-distribuidos/src/routes/endpoints_2/+page.svelte +++ b/material-sistemas-distribuidos/src/routes/endpoints_2/+page.svelte @@ -2,6 +2,10 @@ + + Definindo os endpoints da Biblioteca + +

Definindo os endpoints da Biblioteca

@@ -10,7 +14,7 @@

- Como definimos anteriormente, o escopo do nosso projeto determina que nós devemos fazer um sistema onde seja possível: + Como definimos anteriormente, o escopo do nosso projeto determina que nós devemos escrever uma API REST onde seja possível:

    @@ -20,15 +24,130 @@

- Para tanto, devemos criar, então, os endpoints necessários para que o nosso sistema seja capaz de realizar estas ações. + Para tanto, devemos criar, então, os endpoints necessários para que o nosso sistema seja capaz de realizar estas ações. Mas antes de tudo, vamos recapitular o que é uma API e + o que é o protocolo REST.

-

Verbos, URIs e REST

+

O que é uma API

- No capítulo anterior, criamos um endpoint simples que responde à requisições HTTP + Uma API (Application Program Interface) é uma interface de comunicação entre softwares. +

+ +

+ Pense em uma interface de usuário. Uma interface de usuário serve como meio de comunicação entre o usuário e o software. Já uma API é um meio de comunicação entre softwares. +

+ +

+ Você utiliza APIs constantemente quando escreve um programa. Quando você utiliza alguma função da + biblioteca padrão da sua linguagem + favorita, você está consumindo uma API. +

+ +

+ Por exemplo, o C# tem uma API para a manipulação da entrada e saída de um programa que é executado em um terminal: + a classe System.Console. + Quando você usa Console.WriteLine + para exibir um "Hello World!" no terminal, você não precisa se preocupar com as operações necessárias para mostrar uma mensagem no console. Você apenas chama o método com a mensagem que quer exibir. Estes detalhes internos são abstraídos para você em uma + única chamada de um método. APIs são formas de criar abstrações de funcionalidades. +

+ +

+ Se você precisasse desenvolver um sistema desktop, como você o faria? Para criar uma janela no windows, você precisaria utilizar as APIs do Win32. + No linux, há o X.Org e o Wayland. Você gostaria que sua aplicação fosse multiplataforma, mas para isso você teria que escrever códigos diferentes que utilizariam cada API de cada sistema operacional. Você poderia pesquisar uma biblioteca ou framework que facilita esse processo, abstraindo os detalhes internos de cada API nativa dos sistemas operacionais em uma única API, como o Qt. Seu progama, então, utiliza este framework para mostrar uma interface, que por sua vez, internamente, utiliza as APIs nativas do sistema operacional onde o seu software está sendo executado. Já os sistemas operacionais utilizam as APIs do seu driver de vídeo para exibir as janelas no seu monitor, do controlador USB para ler o teclado e mouse, entre outros. Ou seja, com APIs podemos criar várias camadas de abstração. Todo o ambiente em um computador é composto por softwares comunicando-se uns com os outros, utilizando estas abstrações, através de APIs. +

+ +

+ Há inúmeras formas de se montar uma API. Nos exemplos anteriores, isso acontece através de bibliotecas. Formas de comunicação inter-processo, como sockets, também podem ser + utilizadas. Desta forma, podemos utilizar também protocolos de rede, como o próprio HTTP. Uma API que funciona no protocolo HTTP é uma API Web. +

+ +

+ Como o HTTP é um protocolo de rede para a comunicação entre dois computadores distintos, o software que consome a API e o que a disponibiliza não precisam estar no mesmo computador. Temos, então, um sistema distribuído ou descentralizado.

+
+

O padrão REST

+ +

+ O REST é um padrão arquitetural para aplicações em rede que utilizam o protocolo HTTP. Este padrão impõe algumas restrições para o desenho de APIs Web de forma a melhorar a qualidade e a confiabilidade. + Este padrão foi descrito em 2000 na dissertação de PHD de Roy Fielding e é ubíquo até hoje na arquitetura de sistemas Web. +

+ +

+ REST significa Representational State Transfer (transferência de estado representacional). Podemos entendê-lo, de uma forma muito simplificada (e que não compreende todo o padrão como foi escrito na dissertação), como + uma série de regras para usarmos o protocolo HTTP para acessar ou manipular recursos em um servidor, onde o identificador do recurso é a URI, o verbo HTTP define a ação que se deseja realizar sobre o recurso, o status de resposta + (status code) define o estado da operação, e o conteúdo (corpo) da mensagem é a representação do recurso. +

+ +

+ Voltando ao escopo da API que queremos desenvolver, nós queremos visualizar os livros disponíveis na biblioteca. Para isso, utilizando o padrão REST, podemos criar alguns endpoints como: +

+ +
{`GET /livros`}
+ +

+ O verbo é um GET e a URI é /livros. Isto significa que queremos ler o recurso chamado livros. Uma requisição para este endpoint deveria, portanto, ser respondida com uma lista + de livros disponíveis. +

+ +
{`Request:
+GET /livros
+---
+Response:
+200 Ok
+
+Andrew S. Tanembaum - Distributed Systems 4th Edition
+Thomas H. Cormen - Introduction to Algorithms
+Donald Knuth - The Art of Computer Programming`}
+
+ +

+ E se desejássemos obter um único livro, identificado pelo seu ISBN. Poderíamos fazer um endpoint: +

+ +
{`Request:
+GET /livros/9788574481371
+---
+Response:
+200 Ok
+Yasunari Kawabata - Contos da Palma da Mão`}
+ +

+ Note que agora a URI ficou /livros/9788574481371 onde 9788574481371 é o ISBN do livro, é um dado que o identifica e pode ser uma chave primária. +

+ +

+ E como poderíamos representar o estado de um recurso? Podemos utilizar formatos específicos de dados, + como o XML: +

+ +
{`Request:
+GET /livros/9788574481371
+---
+Response:
+200 OK
+
+
+  9788574481371
+  Contos da Palma da Mão
+  Yasunari Kawabata
+`}
+ +

+ Ou o JSON, que é o mais comumente utilizado hoje em dia: +

+ +
{`Request:
+GET /livros/9788574481371
+
+Response:
+200 Ok
+{
+  "isbn": "9788574481371",
+  "titulo": "Contos da Palma da Mão",
+  "autor": "Yasunari Kawabata"
+}`}
\ No newline at end of file diff --git a/material-sistemas-distribuidos/src/routes/projeto_de_api/+page.svelte b/material-sistemas-distribuidos/src/routes/projeto_de_api/+page.svelte index 62afa2c..13a419b 100644 --- a/material-sistemas-distribuidos/src/routes/projeto_de_api/+page.svelte +++ b/material-sistemas-distribuidos/src/routes/projeto_de_api/+page.svelte @@ -13,7 +13,7 @@ Imagine que você foi escolhido para desenvolver um sistema de informação para a biblioteca da sua faculdade. Os usuários deste sistema serão os funcionários que o utilizarão para gerenciar a biblioteca. Os usuários devem ser capazes de visualizar, cadastrar, editar e remover os livros que estão disponíveis, além - de registrar quando um livro foi emprestado para um aluno. Para isso, vamos desenvolver uma API que irá expor endpoints para cada uma destas operações: + de registrar quando um livro foi emprestado para um aluno. Para isso, vamos desenvolver uma API REST que irá expor endpoints para cada uma destas operações: