OpenAPI documentation of Fyle Platform APIs

Install nvm if you haven't already and use the latest node version (>= v14.15.3)

nvm install v14.15.3

You can check the version by running these commands:

node -v

You should get openapi-cli (>= 1.0.0-beta.25)

npm install -g @redocly/openapi-cli

You can check the version by running

openapi --version

openapi lint src/admin/openapi.yaml
openapi lint src/fyler/openapi.yaml
openapi lint src/approver/openapi.yaml
openapi lint src/common/openapi.yaml

openapi bundle -o reference/admin.yaml src/admin/openapi.yaml
openapi bundle -o reference/fyler.yaml src/fyler/openapi.yaml
openapi bundle -o reference/approver.yaml src/approver/openapi.yaml
openapi bundle -o reference/common.yaml src/common/openapi.yaml

Bring up mock server by running:

docker-compose up

The admin APIs will be available at port 4011, fyler APIs in port 4012, approver APIs in port 4013 and common APIs in port 4014.

Note that the mock server works off the bundled yaml files. So if you make some changes in development, please bundle the file. The mock server will reload automatically.