Ramen GO é uma API para uma aplicação web chamada RamenGo, uma plataforma para que o usuário possa montar um pedido de ramen, escolhendo os tipos de caldos e proteínas do prato.
The API offers the following endpoints:
brothId
(path, required): Id of broth to be retrieved.proteinId
(path, required): Id of protein to be retrieved.Configure the x-api-key for the project.
You can use tools like curl or Postman to test the endpoints, right below are some curl examples:
List available broths:
curl -X GET -H "Content-Type: application/json" -H "x-api-key: YOUR_API_KEY" http://localhost:8080/proteins
List available proteins:
curl -X GET -H "Content-Type: application/json" -H "x-api-key: YOUR_API_KEY" http://localhost:8080/broths
Place an order:
curl -X POST -H "Content-Type: application/json" -H "x-api-key: YOUR_API_KEY" -d "{\"brothId\": \"1\", \"proteinId\": \"1\"}" http://localhost:8080/orders