JaredCE / serverless-openapi-documenter

Serverless plugin to export your config as OpenAPI v3 Documentation and Postman Collection V2
MIT License
42 stars 13 forks source link

[Feat] Support APIS not defined under functions.funcName.events[http or httpApi] #166

Open ilGaru opened 11 months ago

ilGaru commented 11 months ago

First of all, thank you for this plugin! I'm currently working on a serverless project that uses another plugin (serverless-apigateway-service-proxy). This plugin allows to define some APIs endpoint outside of the functions section, like this:

custom:
   apiGatewayServiceProxies:
      - sns:
          path: /testEndpoint
          method: post
          topicName: SNStopic
          request:
             template:
             ...

I need to generate documentation also for these endpoints. Is there a way to achieve this? Thank you

JaredCE commented 11 months ago

Hmmm interesting. Not seen this before. Currently there isn't a way to do this. I could probably hack a way to do it, but it might take a little bit of time.

ilGaru commented 11 months ago

That would be amazing!