Jamdesk Documentation logo

Exemplos

Fixe blocos de código, com abas opcionais por linguagem, em uma barra lateral direita fixa que permanece visível enquanto o leitor rola a página no desktop.

Estes componentes fixam blocos de código em uma barra lateral direita fixa no desktop. O código permanece visível enquanto o leitor rola a página. No celular, os blocos são exibidos em linha.

RequestExample

Use RequestExample para exibir código de requisições de API. Cada bloco de código adicional acrescenta uma aba.

curl -X POST https://api.example.com/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe", "email": "john@example.com"}'

Uso:

<RequestExample>
```bash cURL
curl -X POST https://api.example.com/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "John Doe", "email": "john@example.com"}'
```
</RequestExample>

ResponseExample

Use ResponseExample para exibir respostas de API. Inclua um código de status e uma descrição após o identificador de linguagem.

{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}

Uso:

<ResponseExample>
```json 200: Success
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}
```
</ResponseExample>

O código de status determina a cor do indicador:

  • Verde: códigos de sucesso 2xx
  • Azul: códigos de redirecionamento 3xx
  • Âmbar: erros do cliente 4xx
  • Vermelho: erros do servidor 5xx

Várias linguagens

Adicione vários blocos de código para obter abas:

curl -X GET https://api.example.com/users/123 \
  -H "Authorization: Bearer $TOKEN"

Uso:

<RequestExample>
```bash cURL
curl -X GET https://api.example.com/users/123 \
  -H "Authorization: Bearer $TOKEN"
```

```python Python
import requests

response = requests.get(
    "https://api.example.com/users/123",
    headers={"Authorization": f"Bearer {TOKEN}"}
)
user = response.json()
```

```javascript JavaScript
const response = await fetch("https://api.example.com/users/123", {
  headers: {
    "Authorization": `Bearer ${TOKEN}`
  }
});
const user = await response.json();
```

```go Go
package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.example.com/users/123", nil)
  req.Header.Set("Authorization", "Bearer TOKEN")

  resp, _ := (&http.Client{}).Do(req)
  defer resp.Body.Close()

  body, _ := io.ReadAll(resp.Body)
  fmt.Println(string(body))
}
```

```ruby Ruby
require 'net/http'
require 'uri'
require 'json'

uri = URI("https://api.example.com/users/123")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer TOKEN"

response = http.request(request)
puts JSON.parse(response.body)
```
</RequestExample>

Vários códigos de resposta

Mostre cada código de resposta em sua própria aba:

{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com"
}

Uso:

<ResponseExample>
```json 200: Success
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com"
}
```

```json 400: Bad Request
{
  "error": "validation_error",
  "message": "Email is required"
}
```

```json 404: Not Found
{
  "error": "not_found",
  "message": "User not found"
}
```
</ResponseExample>

Uso combinado

Use RequestExample e ResponseExample juntos em uma página de API. A requisição aparece acima da resposta na barra lateral:

curl -X POST https://api.example.com/orders \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_456",
    "quantity": 2
  }'
{
  "id": "ord_789",
  "product_id": "prod_456",
  "quantity": 2,
  "status": "pending",
  "created_at": "2024-01-15T10:30:00Z"
}

Uso:

<RequestExample>
```bash cURL
curl -X POST https://api.example.com/orders \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "prod_456",
    "quantity": 2
  }'
```
</RequestExample>

<ResponseExample>
```json 201: Created
{
  "id": "ord_789",
  "product_id": "prod_456",
  "quantity": 2,
  "status": "pending",
  "created_at": "2024-01-15T10:30:00Z"
}
```
</ResponseExample>

Formatos de código de status

ResponseExample aceita dois formatos de código de status:

```json 200: Success      // Colon separator

```json 400 - Bad Request // Dash separator

O Jamdesk os interpreta da mesma forma. A aba mostra o código de status e sua descrição.

O que vem a seguir?

Visão geral dos componentes

Veja todos os componentes disponíveis

Fundamentos de MDX

Aprenda a usar componentes no MDX

Exemplos de API

Veja uma página completa de requisição/resposta em ação

Suporte a OpenAPI

Gere documentação de API automaticamente a partir de especificações OpenAPI