apigeelint icon indicating copy to clipboard operation
apigeelint copied to clipboard

Provide best practices description

Open smolnikov opened this issue 6 years ago • 3 comments

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.

smolnikov avatar Aug 21 '18 16:08 smolnikov

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

apetrosian avatar Aug 21 '18 17:08 apetrosian

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

smolnikov avatar Aug 31 '18 12:08 smolnikov

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

yuryninog avatar Dec 09 '21 03:12 yuryninog