🚀 New Release: API-Doc-Crafter just got sharper. Cleaner. Meaner.
Giving my little OpenAPI merging monster some upgrades.

It all started with a simple idea: merge OpenAPI specs from multiple repos.
Now? It transforms outdated Swagger specs to OpenAPI 3+, generates HTML pages with full navigation, and allows customization via config or env.

✨ SecurityRequirement deduplication - because why merge APIs if you can't also merge logic?

🧠 Custom metadata enrichment - inject your info, license, contact, and docs straight from config. No more excuses.

🔁 Better parser fallback - now tries more ways to read broken specs than your average intern in panic mode.

🎭 Variable substitution in outputs - ${variables} be gone. Use env or config, stay DRY, stay sane.

🧪 Tests expanded. HTML, JSON, YAML outputs covered like a nuclear bunker.

🧰 Powered by GraalVM, no reflection, blazing fast.
🐳 Native Docker builds.
🧼 Reflection config surgically trimmed. Less bloat. More edge.

Project: https://github.com/YunaBraska/api-doc-crafter
Happy crafting. And remember: if your docs aren't automated, they're probably lies.

#OpenAPI #Swagger #APIdocumentation #DevTools #GraalVM #Java21 #Docker #Automation #CleanCode #DevLife #APIDocs #OpenSource #DeveloperTools #coding #programming

Do developers need code samples in API documentation?

https://idratherbewriting.com/blog/code-samples-might-not-be-needed-anymore

#APIDocumentation #TechWriting #CodeSamples #AI #DeveloperTools #SoftwareDocumentation #APIs #AIInTechWriting #DevDocs #TechnicalWriting #APIDocs #Coding #AIvsManual #SoftwareDevelopment

🛠️ Api-Doc-Crafter - Last-minute release before 2025! 🎆

lightweight tool (CLI, Docker, GitHub Action) to merge, sanitize, & generate API docs with ease! Built for Developer Experience, Minimalism, & Compliance.

🧩 Merge OpenAPI/Swagger files effortlessly.
🔒 Exclude sensitive endpoints with patterns.
🌐 Whitelabel HTML output
📁 YAML, JSON, & HTML support.
⚡ Blazing fast & portable.
🖌️ Add your own logo & branding.

https://github.com/YunaBraska/api-doc-crafter

#APIDocs #OpenAPI #DevTools #Automation #Sorting #Branding

Just wrapped up my talk at #APIdays Paris!
🚀 Built a wild GenAI tool that turns messy inputs into killer API docs using @Mistral + @HuggingFace.
Turning raw notes & specs into structured documentation? Yes, please.

🔗Demo: https://apidays-ai-novikova.netlify.app/documentation
🖥️ Slides: https://speakerdeck.com/lananovikova10/beyond-the-spec-bringing-context-to-life-with-genai-for-api-docs
📦 Code: https://github.com/lananovikova10/apidays-ai-poc
#AIDocumentation #APIDocs #generativeAI

Hi there.

Any technical writer here?

#technicalwriting #apiDocs

Docs as Code: The Best Guide for Technical Writers

https://dev.to/dumebii/docs-as-code-the-best-guide-for-technical-writers-97c#key-principles-of-docs-as-code

"Docs as Code is a methodology where documentation is treated like code. This means you use the same tools and processes for documentation that you use for code development. By doing this, you integrate documentation into the development process, making it a first-class citizen." -- #DumebiOkolo

#api360 #apiDocs #apiDesign #devRel

Let’s Bring Science Into API Documentation

https://blog.jetbrains.com/writerside/2024/06/let-s-bring-science-into-api-documentation/

"Just like the knowledge of wave patterns enhances a surfer’s performance, understanding the principles of pattern recognition and learning styles can transform our approach to API documentation." -- #SvetlanaNovikova

#theMind #api360 #apiDocs

API Documentation Checklist

https://bump.sh/blog/api-documentation-checklist

"This article provides a checklist to help you identify the documentation you will need for launching your API. We will also include some things to consider post-launch as well to help you continue to improve your documentation." -- #JamesHigginbotham

#api360 #apiDocs #apiDesign

Moving API Docs From Human-Readable to Machine-Readable https://buff.ly/3TPK2KV

"I have more faith that we will get humans to adopt or at least auto-generate OpenAPI and APIs.json than I believe we’ll develop AI to unwind this mess." -- #KinLane

#api360 #apiDocs #apisJSON

Everyone is looking to me for API doc best practices and process. Validating, but also a little intimidating, like the teacher learning the content the night before to stay ahead of the API doc class while teaching seven other classes at the same time.

I'd appreciate y'all sharing any thoughts & references & resources, from theory to implementation.

#technicalWriting #techWriterLife #writeTheDocs #loneWriter #apiDoc #apiDocs #apiDocumentation