swagger-spec.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "UFC RU API",
    "description": "API de consulta e recarga de créditos no cartão do restaurante universitário",
    "version": "2.2.1"
  },
  "paths": {
    "/cartao": {
      "post": {
        "summary": "Busca dados do cartão.",
        "tags": [
          "Cartão"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/cartao"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/cartaoDetalhado"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          },
          "408": {
            "description": "Timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          }
        }
      }
    },
    "/cartao/recarga": {
      "post": {
        "tags": [
          "Cartão"
        ],
        "summary": "Gera um link de recarga para o cartão.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/recarga"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/linkRecarga"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          },
          "408": {
            "description": "Timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          }
        }
      }
    },
    "/cartao/historico": {
      "post": {
        "tags": [
          "Cartão"
        ],
        "summary": "Busca histórico de refeições e recargas do cartão.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/cartao"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/historico"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          },
          "408": {
            "description": "Timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          }
        }
      }
    },
    "/cartao/historico/refeicoes": {
      "post": {
        "tags": [
          "Cartão"
        ],
        "summary": "Busca histórico de refeições do cartão.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/cartao"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/historico"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          },
          "408": {
            "description": "Timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          }
        }
      }
    },
    "/cartao/historico/recargas": {
      "post": {
        "tags": [
          "Cartão"
        ],
        "summary": "Busca histórico de recargas do cartão.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/cartao"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/historicoRecargas"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          },
          "408": {
            "description": "Timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/erro"
                }
              }
            }
          }
        }
      }
    },
    "/cardapio": {
      "post": {
        "tags": [
          "Cardápio"
        ],
        "summary": "Busca cardápio pelo Campus e pelo dia.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/consultaCardapio"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/cardapio"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "cartao": {
        "type": "object",
        "properties": {
          "matricula": {
            "type": "string",
            "example": "123456"
          },
          "cartao": {
            "type": "string",
            "example": "1234567890"
          }
        },
        "required": [
          "matricula",
          "cartao"
        ]
      },
      "cartaoDetalhado": {
        "type": "object",
        "properties": {
          "matricula": {
            "type": "string",
            "example": "123456"
          },
          "cartao": {
            "type": "string",
            "example": "1234567890"
          },
          "aluno": {
            "type": "string",
            "example": "José da Silva"
          },
          "saldo": {
            "type": "number",
            "example": 50
          }
        },
        "required": [
          "matricula",
          "cartao",
          "aluno",
          "saldo"
        ]
      },
      "consultaCardapio": {
        "type": "object",
        "properties": {
          "campus": {
            "type": "string",
            "enum": ["fortaleza", "russas", "sobral", "quixada", "crateus"],
            "example": "russas"
          },
          "data": {
            "type": "string",
            "format": "date",
            "example":"2000-01-20"
          }
        },
        "required": [
          "campus"
        ]
      },
      "cardapio": {
        "type": "object",
        "properties": {
          "almoco": {
            "$ref": "#/components/schemas/cardapioRefeicao"
          },
          "jantar": {
            "$ref": "#/components/schemas/cardapioRefeicao"
          }
        },
        "required": [
          "almoco",
          "jantar"
        ]
      },
      "cardapioRefeicao": {
        "type": "object",
        "properties": {
          "principal": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "vegetariano": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "salada": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "guarnicao": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "acompanhamento": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "suco": {
            "$ref": "#/components/schemas/elementoCardapio"
          },
          "sobremesa": {
            "$ref": "#/components/schemas/elementoCardapio"
          }
        },
        "required": [
          "principal",
          "vegetariano",
          "salada",
          "guarnicao",
          "acompanhamento",
          "suco",
          "sobremesa"
        ]
      },
      "elementoCardapio": {
        "type": "array",
        "items": {
          "type": "string",
          "example": "Item do cardápio (Contém Lactose)"
        }
      },
      "recarga": {
        "type": "object",
        "properties": {
          "matricula": {
            "type": "string",
            "example": "123456"
          },
          "cartao": {
            "type": "string",
            "example": "1234567890"
          },
          "quantidade": {
            "type": "number",
            "example": 20
          }
        },
        "required": [
          "matricula",
          "cartao",
          "quantidade"
        ]
      },
      "historico": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "data": {
              "type": "string",
              "format": "date-time",
              "example": "01-01-2000 00:00:00"
            },
            "operacao": {
              "type": "string",
              "example": "Utilização do Cartão"
            },
            "detalhes": {
              "type": "string",
              "example": "Refeição: Almoço"
            }
          },
          "required": [
            "data",
            "operacao"
          ]
        }
      },
      "historicoRecargas": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string",
              "format": "date-time",
              "example": "01-01-2000 00:00:00"
            },
            "operation": {
              "type": "string",
              "example": "Utilização do Cartão"
            },
            "currentValue": {
              "type": "string",
              "example": "25"
            },
            "rechargedValue": {
              "type": "string",
              "example": "20"
            },
            "lastValue": {
              "type": "string",
              "example": "5"
            }
          },
          "required": [
            "date",
            "operation",
            "currentValue",
            "rechargedValue",
            "lastValue"
          ]
        }
      },
      "linkRecarga": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Pagamento gerado!"
          },
          "link": {
            "type": "string",
            "example": "https://pagtesouro.tesouro.gov.br/#/pagamento?idSessao=415b0bab-68fc-4fd6-9426-50e8f0886f6b&tema=tema-light&btnConcluir=true"
          }
        },
        "required": [
          "message",
          "link"
        ]
      },
      "erro": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "example": "Descrição do erro"
          }
        },
        "required": [
          "message"
        ]
      }
    }
  }
}