README.md

For more information about the DINA Project, please visit the DINA wiki.

Authors

• DINA International consortium - Technical Committee
• DINA team at NRM

DINA Guidelines

• Web API Guidelines - outdated recommendation by TC
• Development Guidelines - draft recommendation by TC
• Release Guidelines - recommendation by TC
• QA Guidelines - draft recommendation by TC
• Licensing Guidelines - draft recommendation by TC
• Visual style Guidelines - draft recommendation by TC
• Cybersecurity Guidelines - draft recommendation by TC

Guidelines in Blueprint format

The .apib format is a markdown format that allows for various tooling. A Makefile is provided that for example can be used to render and validate guidelines written in API Blueprint format.

Usage:

# validate, generate report and HTML versions
make APIB=DINA-Web-API-Guidelines.apib

# run tests
make APIB=DINA-Web-API-Guidelines.apib test

# clean up
make down
make clean

Links

• https://help.apiary.io/api_101/choosing-format/