Skip to content

EduardoNGomes/Java-course-challenger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 Course API

Nesse desafio foi desenvolvido uma API fictícia para uma empresa de cursos de programação, onde foi utilizado um CRUD, para criação de cursos.



✨ Funcionalidades

📖 Cursos

✅ Criação de um novo curso

✅ Listagem de todos os cursos(ativos)

✅ Atualização de um curso pelo id

✅ Atualização do estado de um curso

✅ Remover um curso pelo id



⚙️ Utilizando Localmente


  • Clone o repositório.

  • Dentro de main/resources crie um arquivo application.properties com a informacoes seguindo o padrão do application.properties.example

  • Instale as dependências necessárias usando maven.

  • Execute o arquivo da docker usando docker compose up.

    OBS: E necessário ter a docker instalada no computador.

  • Execute a aplicação usando mvn spring-boot:run.


📡 Endpoints da API

Os seguintes endpoints estão disponíveis:

📖 Course- Endpoints

  • Criação de um novo curso.

    Método: POST

    rota: /course/create

Requisição:

 {
  name: "course-name",
  category:"course-category"
 }

  • Listagem de todos os cursos(ativos)

    Método: GET

    rota: /course?search

OBS: Nesta rota é possível filtrar pelo nome ou categoria

  • Atualização de um curso.

    Método: PUT

    rota: /course/:courseId

    OBS: Todos os parâmetros que esta rota pode receber são opcionais

Requisição:

 {
  name: "course-name",
  category:"course-category"
 }


  • Atualização do estado de um curso.

    Método: PATCH

    rota: /course/:courseId/active



  • Remover um curso.

    Método: DEL

    rota: /course/:courseId



Tecnologias Utilizadas


O arquivo client.http é um arquivo utilizado para fazer todas as possíveis chamadas para a API. Para utiliza-lo, basta ter a extensão RestClient


Contribuidores

Nome Papel
Eduardo N Gomes Back-End

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages