Giter VIP home page Giter VIP logo

thiago-duart / cronos-api Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 527 KB

Esta é uma API de artigos criada com o intuito de estudo. Através dela, pude aprender sobre arquitetura limpa, design patterns, testes unitários, testes de integração, princípios do SOLID e Docker.

JavaScript 0.91% TypeScript 98.77% Shell 0.32%
arquitetura-limpa design-patterns docker solid testes-automatizados testes-unitarios typescript

cronos-api's Introduction

Cronos

Esta é uma API de artigos criada com o intuito de estudo. Através dela, pude aprender sobre arquitetura limpa, design patterns, testes unitários, testes de integração, princípios do SOLID e Docker.

Rodando localmente

Instale as dependências

  pnpm install

Inicie o servidor

  pnpm run dev

Rodando com docker

  docker compose up

Rodando os testes

Para rodar os testes, rode o seguinte comando

Roda todos os teste -->

  pnpm run test

teste unitarios -->

  pnpm run test:unit

teste integração -->

  pnpm run test:integration

Documentação da API

Cria um artigo

  POST /api/article
Parâmetro Tipo Descrição
img strin/Base64/link Obrigatório. exemplo -> data:image/jpeg;base64,/9j23...
title string Obrigatório. exemplo -> Titulo do artigo
article string Obrigatório. exemplo -> conteudo

Resposta

Parâmetro Tipo Descrição
id string 'd7347345fd...'
img strin/Base64/link data:image/jpeg;base64,/9j23...
title string Titulo do artigo
article string conteudo...
createdAt string 2024-03-22T11:50:11.816Z

Retorna um artigo

  GET /api/article/:id
Parâmetro Tipo Descrição
id string Obrigatório. O ID do item que você quer

Resposta

Parâmetro Tipo Descrição
id string 'd7347345fd...'
img strin/Base64/link data:image/jpeg;base64,/9j23...
title string Titulo do artigo
article string conteudo...
createdAt string 2024-03-22T11:50:11.816Z

Retorna todos os artigo

  GET /api/article

atualiza um artigo

  PATCH /api/article/:id
Parâmetro Tipo Descrição
img strin/Base64/link ** nao é Obrigatório**. exemplo -> data:image/jpeg;base64,/9j23...
title string ** nao é Obrigatório**. exemplo -> Update title
article string ** nao é Obrigatório***. exemplo -> conteudo

Resposta

Parâmetro Tipo Descrição
id string 'd7347345fd...'
img strin/Base64/link data:image/jpeg;base64,/9j23...
title string Update title
article string conteudo...
createdAt string 2024-03-22T11:50:11.816Z

deleta um article

  DELETE /api/article/:id

Aprendizados

Aprendi sobre arquitetura limpa, como criar um projeto escalável com uma boa arquitetura. Aprendi sobre design patterns e apliquei os princípios do SOLID. Também aprendi mais sobre testes unitários e de integração. Estava utilizando TDD, que consiste em escrever o teste antes de escrever o código de produção e fazer o mínimo para que o código passe no teste, evoluindo gradualmente. Além disso, aprendi sobre Docker e Docker Compose

cronos-api's People

Contributors

thiago-duart 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.