#apidocs — Public Fediverse posts

New design for Aptivi Newsroom and API docs available!

Aptivi Newsroom was established this year to provide you with the latest news about our projects, while the API documentation sites provide you with automatically-generated API references for our C# projects.

We are very excited to announce that the new design for both the Aptivi Newsroom website and the API documentation site is now available! This plan was an extension to the redesign project of the Aptivi Blog that was done earlier.

We are showcasing the changed design for both mobile devices and for computer users in the below pictures to demonstrate the changes that were made to our sites:

To learn more about this change, please consult the Aptivi Newsroom article below.

New design for Aptivi Newsroom and API docs available!

Aptivi Newsroom was established this year to provide you with the latest news about our projects, while the API documentation sites provide you with automatically-generated API references for our C# projects.

We are very excited to announce that the new design for both the Aptivi Newsroom website and the API documentation site is now available! This plan was an extension to the redesign project of the Aptivi Blog that was done earlier.

We are showcasing the changed design for both mobile devices and for computer users in the below pictures to demonstrate the changes that were made to our sites:

To learn more about this change, please consult the Aptivi Newsroom article below.

EXCLUSIVE: Consistency for the Aptivi Newsroom and API docs design

Last week, we have reported that the June 2026 redesign for the Aptivi Blog had finished in two stages: design and structure. This took a lot of effort into ensuring that responsive design was applied across all form factors, including mobile phones and tablets. This was a project that was planned to fix problems that plagued the older design that we revealed back on February 2026 as part of the bigger milestone.

As we have gathered great feedback, we’d like to extend this effort to include both the API documentation of our projects that use .NET and the Aptivi Newsroom website. We will perform the necessary changes to ensure that our design is:

• Consistent: We will update both sites to be consistent with our new design language, including colors and other element properties.
• Cohesive: We will update both sites to ensure that they become readable across all form factors.
• Reliable: We will update both sites to make the design elements, such as text and images, adapt to different form factors, while making sure that problems related to design are resolved.

This design change, however, has no schedule, so it will slowly roll out according to the results of our experiments. If things go well, we will start rolling it out to a small batch, such as Nitrocid and Terminaux, before extending to larger batches to make sure that any last-minute bugs with the design can be caught early.

Aptivi Newsroom will get the updated design first, then the API documentation design update will come in tiers, which will span for three weeks, as we keep testing the new design to ensure that it reliably achieves our goal.

Currently, there is no set date as to when we’ll start rolling out the changes, but we will showcase them to you in a separate Aptivi Newsroom article once we start pushing the design updates.

EXCLUSIVE: Consistency for the Aptivi Newsroom and API docs design

Last week, we have reported that the June 2026 redesign for the Aptivi Blog had finished in two stages: design and structure. This took a lot of effort into ensuring that responsive design was applied across all form factors, including mobile phones and tablets. This was a project that was planned to fix problems that plagued the older design that we revealed back on February 2026 as part of the bigger milestone.

As we have gathered great feedback, we’d like to extend this effort to include both the API documentation of our projects that use .NET and the Aptivi Newsroom website. We will perform the necessary changes to ensure that our design is:

• Consistent: We will update both sites to be consistent with our new design language, including colors and other element properties.
• Cohesive: We will update both sites to ensure that they become readable across all form factors.
• Reliable: We will update both sites to make the design elements, such as text and images, adapt to different form factors, while making sure that problems related to design are resolved.

This design change, however, has no schedule, so it will slowly roll out according to the results of our experiments. If things go well, we will start rolling it out to a small batch, such as Nitrocid and Terminaux, before extending to larger batches to make sure that any last-minute bugs with the design can be caught early.

Aptivi Newsroom will get the updated design first, then the API documentation design update will come in tiers, which will span for three weeks, as we keep testing the new design to ensure that it reliably achieves our goal.

Currently, there is no set date as to when we’ll start rolling out the changes, but we will showcase them to you in a separate Aptivi Newsroom article once we start pushing the design updates.

When #LLM generates #API #documentation is that detailed and still so much on point, that you start to wonder, if you accidentally gave the AI some code you don't want to share.

You search the chat and don't find this very function.

#Paranoia arises: "Who is watching me!?"

You inspect the chat more thoroughly and find an interface function that calls the "secret" function, but also provides the variable names to justify the LLM's excellent API docs.

Puh, that was close.

#apidocs

When #LLM generates #API #documentation is that detailed and still so much on point, that you start to wonder, if you accidentally gave the AI some code you don't want to share.

You search the chat and don't find this very function.

#Paranoia arises: "Who is watching me!?"

You inspect the chat more thoroughly and find an interface function that calls the "secret" function, but also provides the variable names to justify the LLM's excellent API docs.

Puh, that was close.

#apidocs

Api documentation: Codeberg pages can point to repository/@branch/subdir/stuff.html . So I started with having a documentation directory as part of the source code.

Somewhat awkward, though, to mix commits with tons of doc files witch small code change commits.

Solution: a "docs" repository with a subdirectory for each project. Its commits will also have loads of files, but not mixed in between code changes. Nice.

https://codeberg.org/harald/docs

#programming #codeberg #apidocs #java

🚀 SuCoS v6.2.0 drops with game-changing API documentation! Generate beautiful C# API docs with a single command: `sucos api --project <PATH>`. Zero config, familiar templates, faster than DocFx!

See it live: https://sucos.brunomassa.com/api

#SuCoS #CSharp #DotNet #APIDocs

https://sucos.brunomassa.com/v6.2.0/

🚀 SuCoS v6.2.0 drops with game-changing API documentation! Generate beautiful C# API docs with a single command: `sucos api --project <PATH>`. Zero config, familiar templates, faster than DocFx!

See it live: https://sucos.brunomassa.com/api

#SuCoS #CSharp #DotNet #APIDocs

https://sucos.brunomassa.com/v6.2.0/

Are there any good tools to create API docs from a Laravel app these days? I'm thinking something that would, at least, scaffold some sort of website based on the routes under the API namespace and list their expected parameters based on the requests.

#PHP #Laravel #apis #apiDocs

Are there any good tools to create API docs from a Laravel app these days? I'm thinking something that would, at least, scaffold some sort of website based on the routes under the API namespace and list their expected parameters based on the requests.

#PHP #Laravel #apis #apiDocs

🚀 Behold, the revolutionary 'Claude Code' – the command line tool you'll pretend to use to impress your friends while still googling "how to use command line" 🤓. For an astonishingly fair price, it promises to automate your job while you’re busy scrolling API docs written in every language except Klingon. 🛠️💤
https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-max-plan #ClaudeCode #CommandLine #Automation #TechHumor #DeveloperTools #APIDocs #HackerNews #ngated

🚀 Behold, the revolutionary 'Claude Code' – the command line tool you'll pretend to use to impress your friends while still googling "how to use command line" 🤓. For an astonishingly fair price, it promises to automate your job while you’re busy scrolling API docs written in every language except Klingon. 🛠️💤
https://support.anthropic.com/en/articles/11145838-using-claude-code-with-your-max-plan #ClaudeCode #CommandLine #Automation #TechHumor #DeveloperTools #APIDocs #HackerNews #ngated

🚀 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

🚀 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

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

🛠️ 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

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

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

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

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

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

Making good API docs is vital, and I enjoyed this post from Infobip showing how good API design and description are part of what makes good docs
https://www.infobip.com/developers/blog/the-must-have-content-to-include-in-your-api
#APIdocs #OpenAPI #linkTuesday

Making good API docs is vital, and I enjoyed this post from Infobip showing how good API design and description are part of what makes good docs
https://www.infobip.com/developers/blog/the-must-have-content-to-include-in-your-api
#APIdocs #OpenAPI #linkTuesday

#APIdocs do not have to be boring!

You can enhance how you describe and document the concepts in your #API with cool images 🖼️

If yours is based on #OpenAPI or #AsyncAPI, you can now perfectly size them 📐 on https://bump.sh/

Read how: https://bump.sh/blog/sizing-image-api-documentation?utm_source=mastodon&utm_medium=social&utm_campaign=perfectly-size-images

10 Important Components of API Documentation

https://www.makeuseof.com/api-documentation-important-components/

"An API is only as good as its documentation, so make sure yours is discoverable with top-quality instructions and other important detail." -- #SANDRA_DINDI #makeUseOf

#api360 #apiDocs #documentation

10 Important Components of API Documentation

https://www.makeuseof.com/api-documentation-important-components/

"An API is only as good as its documentation, so make sure yours is discoverable with top-quality instructions and other important detail." -- #SANDRA_DINDI #makeUseOf

#api360 #apiDocs #documentation

Correct technical explanation order

https://hilton.org.uk/blog/explanation-order

"Why most writing explains things in the wrong order..."

#api360 #apiDocs

Correct technical explanation order

https://hilton.org.uk/blog/explanation-order

"Why most writing explains things in the wrong order..."

#api360 #apiDocs

What is an API Product? Design better APIs with a product mindset https://b.mamund.com/3zKhhFh

"We’ll start with the narrower definition and will then extend this to the more general understanding of what an API product is."

#api360 #apiDocs

What is an API Product? Design better APIs with a product mindset https://b.mamund.com/3zKhhFh

"We’ll start with the narrower definition and will then extend this to the more general understanding of what an API product is."

#api360 #apiDocs

Write documentation like you develop code https://b.mamund.com/3zHGrEw

"Docs as Code entails writing documentation using the same tools and workflows used for developing code."

#api360 #apiDocs

Write documentation like you develop code https://b.mamund.com/3zHGrEw

"Docs as Code entails writing documentation using the same tools and workflows used for developing code."

#api360 #apiDocs

Bump builds a central hub for all your APIs https://b.mamund.com/3h1OmFY

"Once all the APIs are documented on Bump, whenever there’s a change, Bump can send notifications and highlight changes compared to the previous version."

#api360 #apiDocs

Bump builds a central hub for all your APIs https://b.mamund.com/3h1OmFY

"Once all the APIs are documented on Bump, whenever there’s a change, Bump can send notifications and highlight changes compared to the previous version."

#api360 #apiDocs