Giter Site home page Giter Site logo

apirequest's Introduction

Claro, aqui está um exemplo de um arquivo README.md para o seu projeto de API RESTful em Python:

# API RESTful Simples em Python

Esta é uma API RESTful simples criada em Python que permite adicionar, listar e excluir notas em um arquivo JSON.

## Pré-requisitos

Antes de começar, você deve ter o Python instalado no seu sistema.

## Instalação

1. Clone este repositório:

   ```bash
   git clone https://github.com/seu-usuario/api-python-simples.git
  1. Navegue até o diretório do projeto:

    cd api-python-simples
  2. Execute o servidor:

    python api.py

A API estará rodando em http://127.0.0.1:8000/ por padrão. Certifique-se de que o servidor esteja em execução antes de fazer solicitações.

Uso

A API possui os seguintes endpoints:

  • POST /adicionar: Adiciona uma nova nota. Envie um JSON no corpo da solicitação com os campos time, tittle e body.

  • GET /Mostrar: Lista todas as notas existentes.

  • DELETE /delete?titulo=TituloDaNota: Exclui uma nota com um título específico.

Exemplo de Uso com cURL

Adicione uma nota:

curl -X POST -H "Content-Type: application/json" -d '{"time":"26/08/2023 21:35", "tittle":"Titulo da nota", "body":"corpo da nota"}' http://127.0.0.1:8000/adicionar

Liste todas as notas:

curl http://127.0.0.1:8000/Mostrar

Exclua uma nota por título:

curl -X DELETE http://127.0.0.1:8000/delete?titulo=TituloDaNota

Lembre-se de substituir TituloDaNota pelo título da nota que deseja excluir.

Contribuições

Contribuições são bem-vindas! Sinta-se à vontade para abrir um problema ou enviar uma solicitação pull.

Licença

Este projeto está licenciado sob a Licença MIT - consulte o arquivo LICENSE para obter detalhes.

apirequest's People

Contributors

nilberthsouza avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.