Terminology Service

Simple Terminology service with REST API. Operating with the reference book and terms in it.

Installation

git clone https://github.com/rimvaliulin/termssrv.git
cd termsrv
python3 -m venv env
source env/bin/activate
pip install django djangorestframework httpie
python manage.py makemigrations
python manage.py migrate
django-admin compilemessages -i env
python manage.py createsuperuser --email [email protected] --username admin
python manage.py loaddata termssrv/terms/fixtures/terms.json

Running

python manage.py runserver

Deinstallation

Ctrl+c
deactivate
cd ..
rm -rf termssrv

API

Getting the list of reference books.

http http://127.0.0.1:8000/books/

GET /books/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 5,
    "next": null,
    "previous": null,
    "results": [
        {
            "description": "",
            "id": 2,
            "name": "Диагнозы",
            "pub_date": "2020-12-08",
            "short_name": "diagnozy",
            "version": "1.0"
        },
        {
            "description": "",
            "id": 2,
            "name": "Диагнозы",
            "pub_date": "2020-12-09",
            "short_name": "diagnozy",
            "version": "2.0"
        },
        {
            "description": "",
            "id": 1,
            "name": "Специальности",
            "pub_date": "2020-12-07",
            "short_name": "specialnosti",
            "version": "1.0"
        },
        {
            "description": "",
            "id": 1,
            "name": "Специальности",
            "pub_date": "2020-12-08",
            "short_name": "specialnosti",
            "version": "2.0"
        },
        {
            "description": "",
            "id": 2,
            "name": "Диагнозы",
            "pub_date": "2020-12-10",
            "short_name": "diagnozy",
            "version": "3.0"
        }
    ]
}

Getting the list of reference books actual as of the specified date.

http http://127.0.0.1:8000/books/2020-12-08/

GET /books/2020-12-05/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "description": "",
            "id": 2,
            "name": "Диагнозы",
            "pub_date": "2020-12-08",
            "short_name": "diagnozy",
            "version": "1.0"
        },
        {
            "description": "",
            "id": 1,
            "name": "Специальности",
            "pub_date": "2020-12-08",
            "short_name": "specialnosti",
            "version": "2.0"
        },
        {
            "description": "",
            "id": 1,
            "name": "Специальности",
            "pub_date": "2020-12-07",
            "short_name": "specialnosti",
            "version": "1.0"
        }
    ]
}

Getting the terms of a specified reference books of the current version

http http://127.0.0.1:8000/books/1/

GET /books/a/
HTTP 200 OK
Allow: GET, PUT, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "code": "bar",
            "value": "green"
        },
        {
            "code": "foo",
            "value": "red"
        }
    ]
}

Validation of elements of a given reference books of the current version

echo '[{"code": "foo", "value": "red"}, {"code": "bar", "value": "black"}]' | http PUT http://127.0.0.1:8000/books/1/

PUT /books/a/1/
HTTP 400 Bad Request
Allow: GET, PUT, HEAD, OPTIONS
Content-Type: application/json

[
    {
        "code": "bar",
        "value": "green"
    }
]

Getting the terms of a given reference books of the specified version

http http://127.0.0.1:8000/books/1/1.0/

GET /books/a/1/
HTTP 200 OK
Allow: GET, PUT, HEAD, OPTIONS
Content-Type: application/json

{
    "count": 3,
    "next": null,
    "previous": null,
    "results": [
        {
            "code": "bar",
            "value": "black"
        },
    ]
}

Validation of an element of a given reference book according to a specified version

echo '{"code": "bar", "value": "black"}' | http PUT http://127.0.0.1:8000/books/1/1.0/

GET /books/a/1/
HTTP 200 OK
Allow: GET, PUT, HEAD, OPTIONS
Content-Type: application/json

{
    "status": "validated"
}

echo '{"code": "bar", "value": "white"}' | http PUT http://127.0.0.1:8000/books/1/1.0/

PUT /books/a/1/
HTTP 400 Bad Request
Allow: GET, PUT, HEAD, OPTIONS
Content-Type: application/json

{
    "status": "not valid"
}