Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rebecavitoria45/achados-e-perdidos

API para um sistema de achados e perdidos.
https://github.com/rebecavitoria45/achados-e-perdidos

csharp dotnet postman sql-server swagger

Last synced: 6 days ago
JSON representation

API para um sistema de achados e perdidos.

Host: GitHub
URL: https://github.com/rebecavitoria45/achados-e-perdidos
Owner: Rebecavitoria45
Created: 2024-05-10T22:52:27.000Z (9 months ago)
Default Branch: master
Last Pushed: 2024-06-29T12:09:08.000Z (7 months ago)
Last Synced: 2024-11-18T23:11:49.033Z (2 months ago)
Topics: csharp, dotnet, postman, sql-server, swagger
Language: C#
Homepage:
Size: 55.7 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


   Achados e Perdidos-API👜👒



## Tecnologias Usadas - Backend 👩‍💻

[![GitHub](https://img.shields.io/badge/GitHub-000?style=for-the-badge&logo=github&logoColor=30A3DC)](https://docs.github.com/)

[![Git](https://img.shields.io/badge/Git-000?style=for-the-badge&logo=git&logoColor=E94D5F)](https://git-scm.com/doc)

[![C#](https://img.shields.io/badge/C%23-239120?style=for-the-badge&logo=c-sharp&logoColor=white)](https://git-scm.com/doc)

[![.NET](https://img.shields.io/badge/.NET-512BD4?style=for-the-badge&logo=dotnet&logoColor=white)](https://git-scm.com/doc)

![MicrosoftSQLServer](https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=for-the-badge&logo=microsoft%20sql%20server&logoColor=white)

![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)

![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)




## Visão Geral

 Bem-vindo à API do sistema de Achados e Perdidos. Esta API permite gerenciar Objetos e documentos perdidos e encontrados, facilitando o registro, a busca e a recuperação desses itens. Além de cadastrar e gerenciar os usuários. 

![tela inicial](https://github.com/Rebecavitoria45/Achados-e-perdidos/assets/117654851/e6a9029a-674b-4d7d-8b7b-cce61fcb43d2)

## Principais Recursos

 ### Usuários

   
 Permite Cadastrar, Listar, Excluir e editar os usuários.

   

![image](https://github.com/Rebecavitoria45/Achados-e-perdidos/assets/117654851/fe7e9701-d3bb-4276-b862-34a52174a82b)

   Exemplo de Retorno do método Get (Busca usuário pelo id):

  ```json

 {

    "dados": {

        "idUsuario": 7,

        "nome": "Rebeca",

        "email": "[email protected]",

        "telefone": 4556677

    },

    "mensagem": "Usuário Encontrado com sucesso",

    "status": true

}

```

### Objetos

 Permite Cadastrar, Listar, Excluir e editar Objetos, além de buscar objetos cadastrados por um usuário. 


![image](https://github.com/Rebecavitoria45/Achados-e-perdidos/assets/117654851/bcd68662-4be3-407e-b2af-63bf1f8c423c)

  Exemplo do Body para o método Post:

  ```json

  {

  "nome": "string",

  "fotoObjeto": "string",

  "ativo": true,

  "descricao": "string",

  "categoria": "Perdido",

  "usuarioId": 0

}

```

### Documentos

 Permite Cadastrar, Listar, Excluir e editar Documentos, além de buscar documentos cadastrados por um usuário. 


![image](https://github.com/Rebecavitoria45/Achados-e-perdidos/assets/117654851/115a17e3-0074-4a0a-b9ee-27aab62765b1)

 Exemplo de Retorno do método Get (Busca documentos pelo id do usuário):

   ```json

    {

    "dados": [

        {

            "idDocumento": 3,

            "tipoDocumento": "Rg",

            "numeroDocumento": "23456795809",

            "nomeCompletoDocumento": "Luan alvez",

            "estadoDocumento": "Amapá",

            "usuarioId": 5,

            "usuario": null

        }

    ],

    "mensagem": "",

    "status": true

}

```

## Observações

Utilizei uma Response Model para padronizar o formato dos retornos

```json

{

    "dados": null,

    "mensagem": "",

    "status": true

}

```

## Instalação

  1.Clone o repósitorio 

 ```

 git clone https://github.com/Rebecavitoria45/Achados-e-perdidos

  cd Achados-e-perdidos 

```

 2.Configure a string de conexão do banco de dados no arquivo appsettings.json: 

   ```

  { 

  "ConnectionStrings": { 

    "DefaultConnection": "Server=.;Database=LostAndFound;Trusted_Connection=True;MultipleActiveResultSets=true" 

  },

 ```

  3.Execute as migrações do banco de dados: 

   ```

    dotnet ef database update

 ```

 4.Inicie o servidor:

  ```

 dotnet run 

 ```

## Contato

   ### Autora: Rebeca vitória

   ### Email: [email protected]

   ### Linkedin: https://www.linkedin.com/in/rebecavitoriadev/