co-cddo / api-standards-linting Goto Github PK
View Code? Open in Web Editor NEWTooling to improve adherance to government guidance and standards for APIs
License: Other
Tooling to improve adherance to government guidance and standards for APIs
License: Other
Right now, at least semver
doesn't specify that it should be an error
as well as the i.e. message
Next quarter we're planning on building out a set of API standards, which we should look to codify these standards too
I.e. in a PUT/POST, it's recommended that there's a maximum length, for security purposes.
To ensure that we're telling consumers what is expected, but may not be added by developers, as it's framework/API Gateway
(Already planned)
https://http.cat/406
https://http.cat/415
Also add:
Maybe also
Run JS-DevTools/npm-publish@v1
with:
package: spectral-ruleset-govuk-public/package.json
access: public
token: ***
registry: https://registry.npmjs.org/
tag: latest
dry-run: false
check-version: true
๐ฆ @govuk-data-standards/spectral-ruleset-govuk-public v0.1.0 is already published to NPM
When we want to have consumers of this, we'll need a level of documentation available for it, so it's consumable.
We should add rules that mirror any of the rules that can be codified as part of https://www.gov.uk/guidance/gds-api-technical-and-data-standards
Similar to those in https://github.com/openapi-contrib/style-guides/blob/master/fhir.yml, we should look at adding FHIR API linting too, as these would be usable across a number of NHS (and beyond) APIs that are FHIR compliant.
This would also be usable wider by other folks who are producing/consuming FHIR APIs.
This repo's project board can be found at https://github.com/orgs/co-cddo/projects/2/views/1
As per federated-api-model
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.