OpenAPI ドキュメントを CloudFront + S3 上でベーシック認証付きでホスティングして Redoc で視覚化する構成を AWS CDK で実装してみた
https://dev.classmethod.jp/articles/aws-cdk-cloudfront-s3-open-api-redoc/

OpenAPI ドキュメントを CloudFront + S3 上でベーシック認証付きでホスティングして Redoc で視覚化する構成を AWS CDK で実装してみた
https://dev.classmethod.jp/articles/aws-cdk-cloudfront-s3-open-api-redoc/
Is there any best practice for how to document authorization on specific endpoints within #openapi documentation? f.e. if an endpoint requires a specific user role. it does not seem to be covered within the spec itself, that only seems to be dealing with authentication.
OpenAPI ドキュメントを CloudFront + S3 上でベーシック認証付きでホスティングして Swagger UI で視覚化する構成を AWS CDK で実装してみた
https://dev.classmethod.jp/articles/aws-cdk-cloudfront-s3-swagger-ui/
Show HN: OpenAPI mocks that don't suck – realistic test data, quick setup
https://beeceptor.com/openapi-mock-server/
#ycombinator #OpenAPI #free #instant_API_mock_server #OAS #OpenAPI_spec #Swagger #AI_powered
Buenas tardes, he publicado la parte 41 del tutorial "Creando Aplicaciones con Spring Boot y su Ecosistema". En esta parte, mostramos como integrar Open API en un proyecto Spring Boot.
Nota: imagen generada con IA generativa.
Introducing: BinkyLabs.OpenApi.Overlay a new library to parse and apply OpenAPI overlays in #dotnet !!!
https://github.com/BinkyLabs/openapi-overlays-dotnet
Over the last week, a good friend of mine Matthieu COSTABELLO and I have been hacking away to produce this new library. It's modeled after Microsoft.OpenAPI, parses, serializes and applies overlays to documents.
With overlays, you can maintain patches to #OpenAPI description, extremely useful when your team doesn't "own" the document but needs to maintain only a few changes. Using this library, a host of OpenAPI tools built in #dotnet will be able to support this specification and new feature!
Stay tuned for more projects from BinkyLabs!
Системное мышление: когда разработчик становится архитектором
Что отличает архитектора от кодера? Не должность, не титул, не стаж. Ответ - в мышлении. В том, кто видит систему целиком, предвидит цепные последствия и способен сказать "нет" быстрому решению, которое отравит код через полгода. Эта статья - честное и местами болезненное размышление о системном мышлении, архитектуре и точке невозврата, после которой разработчик уже не может смотреть на код по-старому.
@bsi
LOL
Liebes BSI,
schafft doch einfach Vorgaben und Standards bzw. initiiert entsprechende Gesetze, dass Geräte nicht per Default "nach Hause telefonieren" und "Telemetrie senden"!
Unterstützt Open-Source ÜBERALL, vor allem in der Verwaltung!
Sorgt dafür, dass europäische Unternehmen mit Achtung der DSGVO Vorrang haben bei Vergaben!
DAS IST DOCH EURE AUFGABE!!!
#OpenSource
#OpenAPI
#dezentraleInfrastruktur
#MadeInEurope
Buenas tardes, he publicado la parte 40 del tutorial "Creando Aplicaciones con Spring Boot y su Ecosistema". Presentamos la especificación Open API y creamos la definición de una API REST.
Nota: imagen generada con IA generativa.
“The goal from starting out is to be able to create an API documentation suite from scratch. The minimal viable document, or the minimum the document must contain before it’s released, includes having all the calls covered, a description, even if only one sentence at this point, for every field and call, section overviews, call examples, and examples of each field. I suggest also creating a Postman collection file for each API suite. A Postman collection file is a complete set of all the requests and that each request may be run by clicking it; it’s a convenience to clients.
Being able to create that document indicates the writer’s proficiency in the mechanics of API documentation. There is a sense of accomplishment when achieving this and comfort with this process. And rightly so. They have the privilege now of calling themselves API documentation writers.”
"Without clear signposting, an agent might miss your API entirely. If it does discover it, large language models (LLMs) may stumble with undocumented behaviors, hallucinate methods or flood your servers with random calls.
So, it’s important to get it right. Thankfully, strategies are emerging to position APIs for AI agents, from new standards to underground tricks. And, it’s more than just “get an MCP server” (though that’s a crucial step).
The jury’s out on what strategy will be most effective. So I’ve structured this guide to start with broadly agreed-upon best practices, then explore ones still taking shape. Most tips apply equally to public, partner and private APIs."
https://thenewstack.io/how-to-prepare-your-api-for-ai-agents/
SpringDoc is a really cool tool that lets you generate #OpenAPI 3.1 specification files from any #Spring app, all you need to do is add annotations. To help you get started, @Philsturgeon has put together this excellent guide:
openapi_first 2.8.0 will make it very simple to turn your existing integration tests into contract tests against an OpenAPI API description. No extra middlewares. No custom test assertions.
Anyone have a preferred tool for viewing/editing #OpenAPI specs? Ideally a client vs a web renderer, and bonus points if it runs on Linux. Thanks....
To make it easier to get started with overlays in #OpenAPI and #AsyncAPI, the maintainers of OpenAPI Format have created a web interface for working through a visual UI. And @Philsturgeon has even put together a practical guide to help you dive in!
CouchDB also seems to be a technically simple solution—although it seems more difficult to use. And it's built with erlang!
1. Automatically generating OpenAPI documentation for your web resources doesn't seem doable, but there's perhaps CouchDB's own form of API documentation.
2. HTTP OPTIONS requests are accepted although poorly documented from what I could find.
It'd be nice if CouchDB supported learning about it's API through OpenAPI documentation.