django_api

開発環境

言語
- Python 3.7
フレームワーク
- Django 2.1
- Django Rest Framework 3.9.0

起動方法

docker-composeを用いて開発環境を管理

# clone
$ git clone git@github.com:takezyou/django_api.git
or
$ git clone https://github.com/takezyou/django_api.git

$ cd django_api
# サービスのbuild
$ docker-compose build
# コンテナ起動
$ docker-compose up

下記にアクセス

http://0.0.0.0:8080/api/v1

テスト方法

DjnagoのAPITestCaseを用いてテストを作成しています。
circleciを用いた自動テストも導入しています。

$ docker-compose run web python manage.py test

API仕様書

swaggerでapiの仕様を確認することができます。
※ api_keyにはToken 9ce17f4922283114472173cb09434973733cf9a8のような形でいれてください。

# localで実行
$ cd django_api/nodejs-server-server
# モジュールのinstall
$ npm install
# サーバーの起動
$ node index.js

下記にアクセス

http://localhost:8000/docs

nodejsがinstallされてない場合コマンドでダウンロードorインストールをする

## Macの場合 どちらかを使うってインストールする nodeとnpmがインストールされる
$ curl "https://nodejs.org/dist/latest/node-${VERSION:-$(wget -qO- https://nodejs.org/dist/latest/ | sed -nE 's|.*>node-(.*)\.pkg</a>.*|\1|p')}.pkg" > "$HOME/Downloads/node-latest.pkg" && sudo installer -store -pkg "$HOME/Downloads/node-latest.pkg" -target "/"
or
$ brew install node

## バージョン管理システムを使う場合
$ brew install nodebrew
# pathを書き込む(bash_profile,zshrcなど適切に書き換える)
$ echo "export PATH=$HOME/.nodebrew/current/bin:$PATH" >> ~/.bash_profile
$ source ~/.bash_profile

$ nodebrew setup

# nodejsのバージョンを確認する
$ nodebrew ls-all

# nodejsの安定版をインストール
$ nodebrew install-binary stable

# useして使えるようにする
$ nodebrew use stable

参考文献

Django
Djangoパスワード管理
Django REST framework カスタマイズ方法 - チュートリアルの補足
Django データベース操作 についてのまとめ
nodebrewでNode.jsをインストールする。