0

Thanks in advance for sharing your ideas and inputs.

We know there are many REST guidelines for API published these days. I use the below for internal code review.

https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md

Is there any way I can automate the code review against the guidelines? Is there any specific tool for the same?

If no, can any of the available tool be configured with custom rules to check against the guidelines?

Any inputs are highly appreciated.

Thanks, Neel

Neel Sarvaiya
  • 15
  • 1
  • 6
  • I doubt that an application following the principles of a real REST architecture will be a valid target for static code analysis tools or linters. For all those pseudo "REST" services, that are pure RPC in nature, however, such tools might be available, though as mentioned, they shouldn't be termed REST at all. REST should be used to achieve full decoupling by adhering to few architecture constraints such as statelessness, cachability and focus on HATEOAS. – Roman Vottner Aug 04 '20 at 10:06

1 Answers1

0

I am using SwaggerHub which has built in standardisation checking but am playing with spectral to automatically review / lint against our standards. API handyman/Arnaud Lauret has an excellent series on how to do this and how spectral can be used to be an "Augmented API reviewer"

API Alex
  • 106
  • 1
  • 1
  • 6