CRUD project with DRF
A very simple boarding app with DRF.
About The Project
유저 정보를 갖고 게시판을 다루는 프로젝트 입니다.
Version
- Python: 3.9
- DB: PostgreSQL 13
- Django: 3.2.8
Built With
Getting Started
Prerequisites
Runserver with command line
$ pip install poetry
$ poetry install
$ export DJANGO_SECRET_KEY=49xq#g3=$7e
$ export DATABASE_URL=postgres://localuser:password@localhost:5432/crud
$ docker-compose up postgres
$ poetry run python manage.py runserver
Runserver with Docker
$ docker-compose up
Authentication
Using JWT
Authorization: Bearer 9944b09199c62b...e4b
Usage
Start the dev server for local development:
$ docker-compose up
API Document
http://localhost:8001/
Endpoints
Post API
Retreive
$ curl http://localhost:8000/api/v1/posts/?limit=3&offset=0
{
"count": 5,
"next": "http://localhost:8000/api/v1/posts/?limit=3&offset=3",
"previous": null,
"results": [
{
"id": 8,
"author": {
"username": "guest2",
"email": "[email protected]"
},
"title": "red title",
"content": "apple",
"created_at": "2021-10-26T15:42:25+0000"
},
{
"id": 7,
"author": {
"username": "guest2",
"email": "[email protected]"
},
"title": "blue title",
"content": "this is sky",
"created_at": "2021-10-26T15:41:46+0000"
},
{
"id": 6,
"author": {
"username": "guest2",
"email": "[email protected]"
},
"title": "sample title 3 edited",
"content": "interesting3 wow",
"created_at": "2021-10-26T13:50:51+0000"
}
]
}
List
$ curl http://localhost:8000/api/v1/posts/2/
{
"id": 2,
"author": {
"username": "guest1",
"email": "[email protected]"
},
"title": "sample title 2",
"content": "interesting2",
"created_at": "2021-10-26T13:29:13+0000"
}
Delete
$ curl -X DELETE http://localhost:8000/api/v1/posts/2/ -H "Authorization: Bearer eajsdfj...asfdasd"
Update
$ curl -X PATCH http://localhost:8000/api/v1/posts/2/ -d '{"content": "edit"}' -H "Authorization: Bearer eajsdfj...asfdasd"
{
"title": "sample title 2",
"content": "edit"
}
Create
$ curl -X POST http://localhost:8000/api/v1/posts/ -d '{"title":"title", "content": "content"}' -H "Authorization: Bearer eajsdfj...asfdasd"
{
"title": "title",
"content": "content"
}
Roadmap
- CI/CD
- deploy.
- Unit tests and coverage.
- Front page to see how it workds.
License
Distributed under the MIT License. See LICENSE for more information.
1 Nov 7, 2021
6 Jul 3, 2022
1 Nov 15, 2021
4 Dec 6, 2022
4 Aug 3, 2022
3 Jul 7, 2022
1 Feb 2, 2022
16 Jul 11, 2022
5 Jan 8, 2022
8 Oct 18, 2022
1 Jun 8, 2022
2 Jun 27, 2022
9 Dec 31, 2022
0 Nov 27, 2021
5 Jan 25, 2022
1 Dec 13, 2021
2 Feb 3, 2022
1 Dec 27, 2021