lgtm-migrator / semtec-api

Uma API feita com Spring Boot que recebe e retorna informações sobre termos técnicos via requisições HTTP.

semtec API

Guarda, manipula e retorna significados de termos técnicos em notação JSON.

Se deseja ler as definições, veja a página web com a mesma base de dados.

Domínio

Cataloga e associa termos técnicos. As entradas são armazenadas e disponibilizadas para consulta de forma serializada.

É capaz de servir páginas HTML e de exibir, atualizar e apagar entradas via requisições HTTP.

Exemplos

Cria uma nova entrada:

curl -X POST localhost:8080/api/v1/termo -H 'Content-type:application/json' -d '{"termo": "interface", "significado": "media as trocas de informação entre componentes de um sistema"}'

Consulta uma entrada pelo ID:

curl -X GET localhost:8080/api/v1/termo/ID

Substitua "ID" pelo número do termo. Novos termos são inseridos a partir do ID 1.

Outras requisições: PUT, DELETE.

Para formatar a saída:

curl -X GET localhost:8080/api/v1/termo/ID | json_pp

ou com jq:

curl -X GET localhost:8080/api/v1/termo/ID | jq -C "."

O argumento -C torna a saída colorida.

Especificação

Estrutura de dados

{
  "id": 1,
  "termo": "teste",
  "significado": "processo controlado e previsível voltado à observação, sem expectativa de sucesso",
  "resumo": "teste: processo controlado e previsível voltado à observação, sem expectativa de sucesso",
  "pagina": "https://semtec.netlify.app/termo/teste",
  "tag": "teste",
  "paginaTag": "https://semtec.netlify.app/tag/teste",
  "front_URL": "https://semtec.netlify.app/",
  "_links": {
    "self": {
      "href": "http://localhost:8080/api/v1/termo/1"
    },
    "termos": {
      "href": "http://localhost:8080/api/v1/termo"
    }
  }
}