Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: Junior-Shyko/api-hyperf
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: main
Choose a base ref
...
head repository: secultce/api-audit
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
Able to merge. These branches can be automatically merged.
  • 2 commits
  • 1 file changed
  • 1 contributor

Commits on Jun 24, 2024

  1. Create README.md

    @Junior-Shyko
    Junior-Shyko authored Jun 24, 2024
    Copy the full SHA
    afacf75 View commit details

  2. Merge pull request #1 from secultce/develop 

    Create README.md
    @Junior-Shyko
    Junior-Shyko authored Jun 24, 2024
    Copy the full SHA
    e0f2d40 View commit details
Showing with 22 additions and 0 deletions.
  1. +22 −0 README.md
22 changes: 22 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# ✨ Api de registro de dados

## Introdução
Bem-vindo à documentação da API do nosso projeto, que foi desenvolvida utilizando o [framework Hyperf](https://hyperf.wiki/3.1/#/en/). Esta API tem o propósito de receber requisições da plataforma do [Mapa Cultural do Ceará](https://mapacultural.secult.ce.gov.br/) sempre que um usuário realizar alterações em determinadas entidades como as oportunidades e as inscrições, tais como criar, alterar ou excluir dados.


# 🎯 Funcionalidades da API

Nossa API foi projetada para suportar as seguintes operações:

- 💾 **Salvar Dados**: Permitir a inserção de dados vindo de uma requisição plataforma do Mapa Cultural do Ceará, após uma usuário realizar uma ação estando logado
- 📃 **Retornar Dados**: Retornar dados da api de uma determinada entidade da plataforma do Mapa Cultural do Ceará.

## 🖥️ Tecnologias Utilizadas

1. **Hyperf Framework**: Um framework PHP de alta performance, ideal para aplicações que requerem alta disponibilidade e escalabilidade.
2. **Docker**: Docker para subir aplicação e seus serviços como banco de dados Mysql
3. **Swagger**: [Swagger](http://swagger.io/) é uma ferramenta de documentação de API que permite a criação de uma interface interativa, facilitando a compreensão e a utilização dos endpoints disponíveis.

## 🎯 Objetivo

Nosso principal objetivo é proporcionar uma integração robusta e eficiente, permitindo que a plataforma do Mapa Cultural do Ceará e essa API trabalhem em conjunto de forma harmoniosa. Com isso, pretendemos melhorar a gestão e o compartilhamento de informações das ações dos usuários, para trazer um contexto claro das ações dos usuários os administradores da plataforma.