SCM structure/contents best practices

Google Cloud Apigee
1

What strategies have worked for you in maintaining your API Proxy’s in external SCM? What has worked when defining an SCM style guide for a large organization with independent API dev teams?

My approach so far is to include a Swagger.json, Properties.json (containing some corporate specific metadata) and a README.md

/
apiproxy/
    petStore-Pets.xml
    policies/
          JSON-Threat-Protection.xml
          OAuth-v20.xml
          Quota.xml
          Spike-Arrest.xml
          Verify-API-Key.xml
    proxies/
          default.xml
    targets/
          default.xml
petStore-Pets.json
petstore-Pets-properties.json
README.md

This is trying to promote discovery/re-use across the company. Now I am trying to figure out how to relate this back to SmartDocs/Swagger spec for the API Product in a programatic way which would include also keeping an equivalent API Product definition in SCM as well, so any examples of where that has been done previously would help as well.

1 Like