Forum Discussion

Stoplight's avatar
Stoplight
Community Manager
9 months ago

Spectral to validate code against design

Originally posted by user Azriel46d to the Stoplight Community on 04/20/2023 at 06:52 ET.

Hi, came across spectral, as we are looking for a tool to be able to lint and enforce a guide on the written API's. Now one scenario that we have is that the API design (openAPI and commited to git) has a set of endpoints , whilst when a developer implements the solution, they do not always follow the API design. Is it possible to diff and compare the design against the implementation? Would it make sense as a use case for spectral?

develop
  • Stoplight's avatar
    Stoplight
    9 months ago

    Skinghar (Staff) [04/24/2023 - 11:18 ET]

    Hello azriel46d, if you have not already checked out our documentation you might try that. https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview Spectral is open source so we typically don't support. We do offer subscriptions that would allow you to leverage our Style guide in the Platform, where you can enforce rulesets against the API design if you are interested. Cheers!

  • Stoplight's avatar
    Stoplight
    Community Manager
    9 months ago

    Skinghar (Staff) [04/24/2023 - 11:18 ET]

    Hello azriel46d, if you have not already checked out our documentation you might try that. https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview Spectral is open source so we typically don't support. We do offer subscriptions that would allow you to leverage our Style guide in the Platform, where you can enforce rulesets against the API design if you are interested. Cheers!