Я создал API, используя AWS Api Gateway. Затем у меня есть документированные части документации для всех объектов (таких как API, RESOURCE, METHOD, MODEL и т. Д.). Затем с помощью AWS Gateway Console я опубликовал документацию для dev stage с версией 1
Но я не уверен, как я (или пользователь API) собираюсь получить доступ к документации?
Существует опция Export, которая может экспортировать документацию как Swagger или OpenAPI3. Это создаст файл .json или .yaml, а затем потребитель должен будет импортировать эти файлы в интерфейс пользователя. Однако это не удобный способ предоставления файла подкачки каждый раз, когда я обновляю документацию для всех потребителей.
Мне было интересно, после публикации документации есть ли потребитель в любом случае доступ к документации напрямую через http. Итак, давайте предположим, что мой dev stage api URL
https://devapi.example.com/v1 поэтому что-то вроде https://devapi.example.com/v1/help должно запустить Swagger UI с последним опубликованным файлом чванства.
Обновление 1
В ASP.NET Web API или .NET Core вы можете включить Swashbuckle, который создает файлы swagger, а также имеет встроенную версию инструмента Swagger UI. Таким образом, после развертывания API пользователь может получить доступ к документации непосредственно из пользовательского интерфейса, например, https://devapi.example.com/swagger.
Я надеялся на то же самое из шлюза AWS. После публикации документации она должна сделать эту документацию доступной через некоторый предопределенный путь к ресурсу.