search

apigee / apigeelint

Static code analysis for Apigee proxy bundles to encourage API developers to use best practices and avoid anti-patterns.
Apache License 2.0
93 stars 71 forks source link

Provide best practices description #121

Open smolnikov opened 6 years ago

smolnikov commented 6 years ago

Readme says this linter is to:

encourage API developers to use best practices and avoid anti-patterns

but there's no links to the description of how these best practices should work and how avoiding them can affect proxy quality or result in bugs.

I suggest to add the links to best practices description in Apigee docs/community forum or create wiki pages with each practice description.

apetrosian commented 6 years ago

Good idea, here is a good starting point: https://community.apigee.com/articles/44662/the-book-of-apigee-edge-antipatterns.html

smolnikov commented 6 years ago

One more link to use https://docs.apigee.com/api-platform/fundamentals/best-practices-api-proxy-design-and-development

yuryninog commented 2 years ago

Hi! I have created a PR adding those links to the README https://github.com/apigee/apigeelint/pull/288 CC: @gbrail