Python: Testar a sua API REST

Esta documentação faz parte do guia Criação de uma API REST. Consulte o guia completo aqui: Guia passo a passo para construir uma API REST com Flask em Python.

👋 Bem-vindo à documentação da Stackhero!

A Stackhero disponibiliza uma solução Python cloud pronta a usar, concebida para simplificar o seu processo de deployment:

• Implemente a sua aplicação em produção em segundos com um simples git push.
• Utilize o seu próprio domínio, com configuração automática de certificado HTTPS para ligações seguras geridas por si.
• Conte com backups automáticos, atualizações com um clique e preços previsíveis, para que se possa focar no seu código e não na gestão da infraestrutura.
• Beneficie de elevada performance e segurança numa infraestrutura privada e dedicada. O seu ambiente está isolado e protegido.

Poupe tempo e simplifique o seu workflow: pode ter o seu código a funcionar com o alojamento Python cloud da Stackhero em apenas 5 minutos.

Assim que o servidor estiver a correr, pode interagir com a sua API usando o cURL. Eis alguns exemplos de comandos:

• Obter todas as tarefas:

  curl -s http://localhost:8080/api/tasks
  # Output:
  # {
  #   "tasks": [
  #     ...
  #   ]
  # }
  

• Obter uma tarefa específica (ID 2):

  curl -s http://localhost:8080/api/tasks/2
  # Output:
  # {
  #   "task": {
  #     ...
  #   }
  # }
  

• Criar uma nova tarefa:

  curl -s -X POST -H "Content-Type: application/json" \
  -d '{"title": "New task", "description": "Created with cURL"}' \
  http://localhost:8080/api/tasks
  # Output:
  # {
  #   "task": {
  #     ...
  #   }
  # }
  

Dica: Para uma saída mais legível, pode canalizar o resultado para o jq. Por exemplo, curl -s http://localhost:8080/api/tasks/2 | jq torna o JSON mais fácil de ler.

Exemplo de API REST Python com Flask, a correr no Stackhero Code-Hero, com o servidor (1) e o cliente a usar cURL (2)