Skip to content
Australian National API Design Standards
JavaScript
Branch: master
Clone or download
colugo Merge pull request #5 from TomChapple/hotfix/name-conven-spelling-for…
…matting

Hotfix: Spelling and Formatting in "Naming Conventions"
Latest commit 44aada3 Dec 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
open-api-templates initial publishing after ADDC approval Dec 6, 2019
sections Merge pull request #5 from TomChapple/hotfix/name-conven-spelling-for… Dec 18, 2019
.gitignore initial publishing after ADDC approval Dec 6, 2019
README.md initial publishing after ADDC approval Dec 6, 2019
gulpfile.js initial publishing after ADDC approval Dec 6, 2019
package-lock.json
package.json

README.md

Australian Government - National API Design Standards (NAPIDS)

The National API Design Standards (NAPIDS) enable developers building APIs to move past common decision points quickly by referencing pre-agreed, best practice design patterns and implementing their APIs according to these standards.

This common design standard simplifies the process for both consumers and developers of APIs, accelerating API uptake and use.

The NAPIDS are unique. They are designed for participation with API development communities within and outside government by combining the best of open-source software development practice and culture with administrative rigour and oversight.

This repository is being used to seek feedback from the working group, and also provide a view to the general public on the standards that are being created within government. These standards should also be applicable for entites outside of government and their use is encouraged.

For more information see the contact information below.




Contact Information




Contributing to this standard

We're committed to undertaking conversations relating to the technical standards in the open. Questions or comments that participants might ask us via email or private message are likely to be questions or comments other participants have as well. Our answers will be of interest to everyone. There are likely to be experiences and lessons everybody working in this ecosystem can learn from. Having these conversations transparently helps us reduce duplication, resolve issues faster and keep everyone up to date with the conversation.

We ask that all contributors to the Australian Government API Standards repositories comply with the GitHub Community Forum Code of Conduct.

In addition, it would be appreciated if the following rules are adhered to when commenting or contributing:

  • Please provide a single, considered response to each proposal covering all feedback concerning the proposal.

  • For transparency, if you work at or are associated with an organisation with an interest in the standards, please indicate this in your response.

  • Please ensure you are aware of and compliant with any social media guidelines or internal processes for response set by your organisation before providing feedback.




Building for Distribution

This standard is broken into a number of sections that are available in the sections folder. These can be rebuilt, and a table of contents generated using the build tool gulp.

The process to get this set up is as follows:

  1. Install npm and node.js (npm: 6.9.0 / node: 10.16.0)
  2. Install gulp-cli and gulp (npm install gulp-cli -g && npm install gulp -D)
  3. Install project dependencies (npm install --save)
  4. Run gulp (gulp)

This will create a target directory with a combined.md and combined.pdf files for use.

Reference

This concept is based on the work of the Consumer Data Right published by Data61. See https://github.com/ConsumerDataStandardsAustralia/standards for more information.




Statement of Contribution

These National API Design Standards are collaboration between the Commonwealth of Australia, State of Western Australia, the State of South Australia, the State of Queensland, the State of Tasmania, the State of New South Wales, the Northern Territory, the Australian Capital Territory and the State of Victoria. All these Australian government jurisdictions have contributed to, and have approved, the use of these National API Design Standards.

The contributing parties are collectively known as the National API Design Standards working Group. Upon publication and circulation, this group will be known as the National Working Group for the purposes of iteration, adaptation and improvement of the National API Design Standards.

License

Creative Commons BY SA 4.0 International

© The State of Victoria 2019

With the exception of the Commonwealth Coat of Arms, the Coat of Arms of the State of Victoria and the logo of the Department of Prime Minister & Cabinet, and where otherwise noted, this product is provided under a Creative Commons Attribution-Share Alike 4.0 International (CC BY-SA 4.0) license.

There is no guarantee that the information in this document is totally accurate or complete. Therefore, you should not solely rely on this information when making a commercial decision.

The National Working Group is committed to providing web accessible content wherever possible.

You can’t perform that action at this time.