https://github.com/approvers/devlaza-back
https://github.com/approvers/devlaza-back
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/approvers/devlaza-back
- Owner: approvers
- Created: 2020-03-24T13:50:12.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2020-06-01T13:04:04.000Z (about 6 years ago)
- Last Synced: 2026-06-27T08:14:37.467Z (8 days ago)
- Language: Kotlin
- Size: 352 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Devlaza API
## Overview
An API for devlaza.
## How to boot server
First, You need to execute the command shown below to boot the API server.
```bash
docker-compose up -d
```
Then, set mail auth info.
```bash
export MAILADDRESS=${Your mail account address.}
export PASSWORD=${Your mail account password.}
```
Finally, execute this command on the project root directory.
```bash
./gradlew bootRun
```
## Commands
### Create new user
POST `http://localhost:8080/users/new`
#### query
- name: String
- password: String
- showId: String
- mailAddress: String
You will receive mail from `${MAILADDRESS}` to check if the email is valid or not.
### Login
POST `http://localhost:8080/users/login`
#### query
- address: String
- password: String
If you succeed in authentication, you will get a login token.
### Get user info
GET `http://localhost:8080/users/`
\ is user id.
### Create Project
POST `http://localhost:8080/projects/` <= Don't forget last `/`!!!
#### query
- name: String
- token: String
- introduction: String
- sites: String
- tags: String
If you want to specify multiple sites and tags, they need to be separated by `+`.
Format of sites is `title,url`
### Get all projects
GET `http://localhost:8080/projects/`
### Get Project Info
GET `http://localhost:8080/projects/`
\ is project id.
### Search project with some parameters
GET `http://localhost:8080/projects/contidion`
query
- keyword: String
- user: String
- tags: String
- sort: String(asc|desc|popular)
- recruiting: Int(1: open 0: close 2: both)
- searchStartDate: String(LocalDate)
- searchEndDate: String(LocalDate)
### Join to project
PATCH `http://localhost:8080/projects/join/`
\ is project id.
query
- token: String
### Leave from project
DELETE `http://localhost:8080/projects/leave/`
\ is project id.
query
- token:String
### Delete project
DELETE `http://localhost:8080/projects/`
\ is project id.
query
- token:String
### GetUserInfoWithToken
POST `http://localhost:8080/auth/`
query
- token:String