Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 1.79 KB

README.md

File metadata and controls

80 lines (57 loc) · 1.79 KB
Raw

ShyNotes (API)

  1. Stack
  2. API

Stack

Core

  • Deno
  • TypeScript
  • MongoDB

Libs

API

Criar uma nota

  REQUEST: POST /notes
  BODY: JSON {
    name,
    content
  }
Parâmetro Tipo Descrição
name string Obrigatório. Nome da nota.
content string Obrigatório. Conteúdo da nota.

Pegar uma nota

  REQUEST: GET /notes/{name}
  RESPONSE: JSON {
    name,
    content
  }
Parâmetro Tipo Descrição
name string Obrigatório. Nome da nota.
content string Obrigatório. Conteúdo da nota.

Retornará um JSON com os valores da nota.

Atualizar uma nota

  REQUEST: PUT /notes/{name}
  BODY: JSON { content }
Parâmetro Tipo Descrição
name string Obrigatório. Nome da nota.
content string Obrigatório. Conteúdo da nota.

Apagar uma nota

  REQUEST: DELETE /notes/{name}
Parâmetro Tipo Descrição
name string Obrigatório. Nome da nota.

Author

@João Pedro Holanda Neves