search

GSA / api-standards

API Standards for GSA
Other
30 stars 8 forks source link

Add implementation profiles or playbooks #31

Open Ryandaydev opened 7 years ago

Ryandaydev commented 7 years ago

As teams implement these standards on specific technology stacks, they can contribute back to the rest of the organization by demonstrating what type of coding or configuration was necessary. They could document these in "implementation profiles" or "implementation playbooks".

For example, how do you "Enable CORS" with node.js/express? How do you put the version in the path for JAX-RS?

I am currently doing this for a technology stack in IC and it is a similar process to what we did previously on the Prototype City Pairs API standards page.

Ryandaydev commented 7 years ago

Would be good to create a blank template for this that teams could clone and add to the repo for each technology.

Sample template might be something like:

Standards Item Implementation tips Notes or limitations
Enable CORS Some setting here Some note about it

After going through this exercise a couple of times, It occurs to me that some numerical structure on the standards might make this easier. For instance, if we update the standards with 1.A.I, or something like that.