82 api documentation needed

l3montree-dev / devguard

DevGuard Backend - Manage your CVEs seamlessly, Integrate your Vulnerability Scanners, Security Framework Documentation made easy, Compliance to security Frameworks - OWASP Incubating Project

https://flawfix.dev

Other

37 stars 4 forks source link

82 api documentation needed #94

Closed seb-kw closed 3 months ago

seb-kw commented 3 months ago

Fixes: https://github.com/l3montree-dev/flawfix/issues/82

As suggested in https://github.com/l3montree-dev/flawfix/issues/82#issuecomment-2150285858 we are testing swaggo for api spec/ doc generation.

So far:

Misc route /api/v1/health
Misc route /api/v1/whoami
/api/v1/vulndb
/api/v1/vulndb/{cveId}

seb-kw commented 3 months ago

@timbastin & @Refoo0 can you please take a look at how you find this way of creating the API documentation and provide feedback?

Good example: https://github.com/l3montree-dev/flawfix/blob/2b65497e3b010f72b16d1769f849e92ecb7ed6ff/internal/core/vulndb/vulndb_controller.go#L34-L47

timbastin commented 3 months ago

@seb-kw I think it is fine! We can do it that way