Skip to content

kaishuu0123/blockdiag-api

Repository files navigation

blockdiag-api

GitHub release Docker Pulls

Demo

Use docker-compose

$ docker-compose build app
$ docker-compose up

API Reference

  • endpoint: /api/v1/<diagram type (actdiag or blockdiag ...)>
  • http method: POST
  • http header: Content-Type: application/json;
  • JSON payload
    {
      "source": "<diagram syntax>"
    }
  • example curl command
    $ curl -XPOST \
       -H 'Content-Type: application/json' \
       -d '{ "source": "blockdiag {\n  A -> B; \n B -> C; \n}" }' \
       http://localhost:8000/api/v1/blockdiag

Change URL prefix

Please set BLOCKDIAG_API_SUBDIR environment variable.

BLOCKDIAG_API_SUBDIR=/hello python server.py

or

Edit docker-compose.yml

-    environment:
-    - BLOCKDIAG_API_SUBDIR=/
+    environment:
+    - BLOCKDIAG_API_SUBDIR=/hello

Access to http://<blockdiag-api URL>/hello

Development

  • python 3.6.5
  • Node.js v8.11.2
  • npm v5.6.0

Server Side

$ pip install -r requirements.txt
$ python server.py

Client Side

$ cd ui-src
$ npm install
$ npm run start