How to document SNS

user_4432463 0
Viewed 48

HTTP APIs have OpenAPI specs (and Swagger UI)

Has anybody come across a technology or approach for maintaining live documentation of SNS topics and schemas?

amazon-sns openapi
1 Answers

Use CloudFormation templates to set up, deploy, and document your Amazon SNS configuration. For example, this is how you would describe a topic in SNS:

Type: AWS::SNS::Topic
Properties: 
  ContentBasedDeduplication: Boolean
  DisplayName: String
  FifoTopic: Boolean
  KmsMasterKeyId: String
  Subscription: 
    - Subscription
  Tags: 
    - Tag
  TopicName: String

Check more on this here. You can also share your YAML or JSON CloudFormation templates, if needed.

user_55428570
Related