Skip to content
DataMiner DoJo

More results...

Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
Search in posts
Search in pages
Search in posts
Search in pages
Log in
Menu
  • Updates & Insights
  • Questions
  • Learning
    • E-learning Courses
    • Empower Replay: Limited Edition
    • Tutorials
    • Open Classroom Training
    • Certification
      • DataMiner Fundamentals
      • DataMiner Configurator
      • DataMiner Automation
      • Scripts & Connectors Developer: HTTP Basics
      • Scripts & Connectors Developer: SNMP Basics
      • Visual Overview – Level 1
      • Verify a certificate
    • Video Library
    • Books We Like
    • >> Go to DataMiner Docs
  • Expert Center
    • Solutions & Use Cases
      • Solutions
      • Use Case Library
    • Markets & Industries
      • Media production
      • Government & defense
      • Content distribution
      • Service providers
      • Partners
      • OSS/BSS
    • Agile
      • Agile Webspace
      • Everything Agile
        • The Agile Manifesto
        • Best Practices
        • Retro Recipes
      • Methodologies
        • The Scrum Framework
        • Kanban
        • Extreme Programming
      • Roles
        • The Product Owner
        • The Agile Coach
        • The Quality & UX Coach (QX)
    • DataMiner DevOps Professional Program
      • About the DevOps Program
      • DataMiner DevOps Support
  • Downloads
  • More
    • DataMiner Releases & Updates
    • Feature Suggestions
    • Climb the leaderboard!
    • Swag Shop
    • Contact
    • Global Feedback Survey
  • PARTNERS
    • All Partners
    • Technology Partners
    • Strategic Partner Program
    • Deal Registration
  • >> Go to dataminer.services

How to document user definable APIs

Solved1.05K views19th October 2023API
4
Mieke Dryepondt [SLC] [DevOps Advocate]3.60K 26th September 2023 0 Comments

I would like to generate documentation for the APIs I’ve created on my System.

How can I do this?

What is the advised way to document my API?

Marieke Goethals [SLC] [DevOps Catalyst] Selected answer as best 19th October 2023

1 Answer

  • Active
  • Voted
  • Newest
  • Oldest
4
Thomas Ghysbrecht [SLC] [DevOps Enabler]4.84K Posted 26th September 2023 0 Comments

Hi Mieke,

There is no automated way to generate API docs from User-Defined APIs configured in DataMiner. There is a reply to another Dojo question that elaborates a bit more about that: https://community.dataminer.services/question/user-defined-api-overview-and-documentation-of-deployed-apis/answer/104948/

As mentioned in that reply, there are editor tools out there that you can use to write API docs according to the Open API specification. This will allow you to load these files into other tools that visualizes and tests them. I found a Visual Studio Code extension called ‘OpenAPI (Swagger) Editor‘ which seems promising for this purpose.

Marieke Goethals [SLC] [DevOps Catalyst] Selected answer as best 19th October 2023
Please login to be able to comment or post an answer.

My DevOps rank

DevOps Members get more insights on their profile page.

My user earnings

0 Dojo credits

Spend your credits in our swag shop.

0 Reputation points

Boost your reputation, climb the leaderboard.

Promo banner DataMiner DevOps Professiona Program
DataMiner Integration Studio (DIS)
Empower Katas
Privacy Policy • Terms & Conditions • Contact

© 2025 Skyline Communications. All rights reserved.

DOJO Q&A widget

Can't find what you need?

? Explore the Q&A DataMiner Docs