This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool? https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html https://dotnet.github.io/docfx/ I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated... - Source: Hacker News / 6 months ago

Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/. Source: over 2 years ago

We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead. Source: over 2 years ago

I use docfx from microsoft to generate documentation for all my oss libraries. Source: over 2 years ago

My best guess would be that there's a CI/CD pipeline in GitHub that utilizes DocFX to convert the Markdown files to HTML. The constructed HTML files are then placed in an Azure Storage account that configured for Static Website Hosting combined with Azure CDN. Source: almost 3 years ago

Swagger descriptor for REST API with nice Swagger UI console. Nowadays, it is a standard de facto. Microservices should be accessible via HTTP and operate with data in a human-readable JSON format. As a bonus, it is super easy to generate data types and API client code for the client side (it works well for a TypeScript-based front-end, for example). - Source: dev.to / about 2 months ago

Often used for cases where a project exposes a REST or other type of API service. Open API is a popular method of documenting such API services. It can also be used along side tools such as Swagger Codegen to produce boilerplate code for API interaction / testing purposes. There may also be support files for popular API testing tools such as Postman or Insomnia. This makes it easier at a glance to see what data is... - Source: dev.to / 6 months ago

Regarding the IO, there could also be low-code tools. Swagger could be taken as inspiration. Swagger codegen is a great tool that allows you to declaratively produce code to interact with APIs. - Source: dev.to / 11 months ago

Personally I would try to put as much business logic as possible into your API that runs on server. Use a format like swaggger (https://swagger.io/tools/swagger-codegen/) to auto generate the client SDKs for every platform you support. Source: about 1 year ago

It sounds like you want an OpenAPI spec. This can be written by hand or partially generated using a crate like utoipia. Once you have an OpenAPI spec you can generate clients in a myriad of languages using the (swagger codgen)[https://swagger.io/tools/swagger-codegen/] tools. Source: about 1 year ago