Coder Social home page Coder Social logo

Comments (7)

emicklei avatar emicklei commented on August 23, 2024

+1 . I would like to create a Go client to document my systems

from java.

simonbrowndotje avatar simonbrowndotje commented on August 23, 2024

Now the API has stabilised, I'm looking at options to document it. Any thoughts on Swagger, Apiary, etc over JSON Schema?

from java.

emicklei avatar emicklei commented on August 23, 2024

I worked a lot with Swagger (Java and Go) and the new 2.0 would be my suggestion.

from java.

toddmeinershagen avatar toddmeinershagen commented on August 23, 2024

I am fine with Swagger. It has a lot of support on the .NET side with the Azure API Management supporting import of a Swagger file for REST endpoints.

from java.

simonbrowndotje avatar simonbrowndotje commented on August 23, 2024

This is still a work in progress (the views and styles properties of the workspace are not yet documented), but I've added the source for a Swagger definition to this repo -> https://github.com/structurizr/java/blob/master/swagger.txt

I'll host the resulting JSON on api.structurizr.com at some point.

from java.

simonbrowndotje avatar simonbrowndotje commented on August 23, 2024

It doesn't include the authentication mechanism, but I think this Swagger JSON covers the JSON schema for Structurizr workspaces.

from java.

simonbrowndotje avatar simonbrowndotje commented on August 23, 2024

Just to close this issue, an OpenAPI 3.0 specification can be found here -> https://structurizr.com/help/web-api

from java.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.