Один Swagger вместо сотни страниц Confluence: как в Рунити навели порядок в API-документации

Привет, Хабр! На связи Маргарита Сорочинская, технический писатель отдела архитектуры в Рунити. Хочу рассказать, как мы в компании подошли к описанию API в Swagger — и почему решили перенести туда всё, что раньше жило в Confluence. А еще поделюсь с вами стартерпаком для описания API в Swagger, пошаговой инструкцией и всеми ссылками, чтобы для вас этот путь был уже более простым :) Навигация по тексту:

https://habr.com/ru/companies/runity/articles/961156/

#api #swagger #swaggerui #swaggertypescriptapi #confluence #git #gitlab #методы #документация #документирование_проектов

Antwort des Dienstleisters auf unsere Support-Anfrage, warum die "REST-API" unseren "Accept: application/json" ignoriert und trotzdem immer mit HTML antwortet:

"Die neue REST-API liefert immer nur HTML zurück, das ist so weit in Ordnung."

Muss ich erwähnen, dass die URL-Pfade in keinster Weise #RESTful sind und GET-Requests Aktionen auslösen? 🫠

Aber es gibt ein Swagger UI!😅

#RestApi #SwaggerUI

For REST 📡 API's written in Go 🚶, you should take a quick look at github.com/go-fuego/fuego. Getting an OpenAPI-Spec 📜 & a SwaggerUI 🖥️ without any extra effort, is a huge win!

#REST #API #GoLang #OpenAPI #Swagger #SwaggerUI #Fuego #GoFuego #WebDevelopment #GoProgramming #APIManagement #ProgrammingTips #TechStack #OpenSource

Good progress on the #dweb REST APIs and improvements to the #OpenAPI docs today, all with the help of #actix and #utoipa

BTW #SwaggerUI is really cool

A few days ago I knew nothing about these but now I have a working API that is documented and can be tested live while reading those docs.

Someone asked if I might support #GraphQL but I haven't looked into that. Convince me that I should!

Генерируем в maven Java-модуль для OpenAPI из Swagger YAML

Допустим отдел аналитики подготовил нам Swagger YAML с описанием API доступа к какому-то сервису: xyz-swagger-v1.0.0.yaml. Как автоматизировать генерацию библиотеки для доступа к API по этому описанию, если у вас maven? Полного мануала почему-то нигде нет, так что я собрал в одну всю информацию о реализации и возможных проблемах.

https://habr.com/ru/articles/839358/

#mvn #maven #mavenplugin #yaml #swagger #swaggerui #swaggerautogen #swaggerui #openapi

Управление сервером со смартфона

Из любого SSH-клиента можно установить канал с сервером и управлять им стандартными командами в консоли. Есть такие клиенты и для смартфона. Многие знают и используют консоль Termux под Android, которая запускает с телефона стандартный OpenSSH. Но есть варианты ещё удобнее, даже с графическим интерфейсом.

https://habr.com/ru/companies/ruvds/articles/824352/

#ruvds_статьи #RebootX_OnPrem #RebootX #Amazon_Web_Services #AWS #Microsoft_Azure #Clever_Cloud #Google_Cloud #GCP #OVH #Scaleway #Grafana #OpenAPI_Specification #SwaggerUI #Docker_Compose #swellsh #Bash #Tmux #Termux #bashcompletion #Webmin

Yes, #SwaggerUI is a great tool to quickly host a reference documentation from an #OpenAPI file, however it's not very good with complex and nested data structures and descriptions will become unreadable. If you have such models in your #API, maybe look into different tools.

I’ve updated a dependency producing #OpenAPI schema, which has also updated its OpenAPI spec version from 3.0 to 3.1 and #SwaggerUI that has just recently announced support for 3.1.
Previous SwaggerUI rendering 3.1 spec does not show any of your tagged unions names - it just shows “object”.
So this was an unexpected event considering that it is a minor version change and SwaggerUI is probably the most famous viewer for a OpenAPI schema.

https://swagger.io/blog/swagger-supports-openapi-3-1/

https://github.com/SMILEY4/ktor-swagger-ui #ktor #kotlin #OpenAPI #swagger #SwaggerUI

Fellow #dotNET developers, I have a repo that has already all #DTO objects and a #SwaggerUI #OpenAPI definition. Now I am about to write two clients—one will be an #ASPNETCore website using that API, the other is a .NET #MAUI client. Which route would you go for a client SDK that connects the clients with the #AzureFunctions API?

Well, one of 6 endpoints have now #OpenAPI #docs. I totally need to improve my #documentation writing skills 😁

#waytogo #devlife #Azure #OpenWeb #SwaggerUI #CASBAN6

über die dip api des bundestages sind nun auch kürzlich geänderte einträge abrufbar. siehe kapitel 2.6: https://draftable.com/compare/zKXNmlxOnQcb

zudem sind ist die dokumentation neben der pdf-version auch in weiteren versionen verfügbar:

swagger-ui
https://search.dip.bundestag.de/api/v1/swagger-ui/

openapi yaml
https://search.dip.bundestag.de/api/v1/openapi.yaml

#openbundestag #opendata #openparliaments #openapi #swaggerui

I just started to implement #OpenAPI on my #AzureFunctions #API… seems like this will keep me busy all week long (as it is my private side project). Not sure about the #benefits for my #CASBAN6 project, though.
#devlife #Azure #OpenWeb #SwaggerUI

Documentation de l'API de Cloud-IAM directement depuis l'app et les requêtes sont automatiquement authentifiée avec votre compte 👌

#openapi #swaggerui #jwt #oauth https://t.co/PIOtXbZRNE