Comments (7)
+1 . I would like to create a Go client to document my systems
from java.
Now the API has stabilised, I'm looking at options to document it. Any thoughts on Swagger, Apiary, etc over JSON Schema?
from java.
I worked a lot with Swagger (Java and Go) and the new 2.0 would be my suggestion.
from java.
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.
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.
It doesn't include the authentication mechanism, but I think this Swagger JSON covers the JSON schema for Structurizr workspaces.
from java.
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)
- C4PlantUMLExporter not following C4-PlantUML best practices with c4plantuml.tags true HOT 1
- How do you extend a deploymentNode?
- Add support of note objects
- Add support of horizontal text alignement in description
- [DSL] A relationship between ... already exists, property to ignore this HOT 1
- Use !include with private URL
- Usage for really big and complex systems
- Delete relationship
- Implied relationship don't preserve tags in scripts
- Include systems to several groups
- Add support to filter on element properties using DSL
- Unknown model item type on 'element' HOT 1
- How to have all child relationship description display on parent context view?
- Support observing changes (at least to model)
- Ability to include single files as documentation
- Unable to call parse() methods in plugins due to DSL parser validation additional curl brace validation HOT 1
- Workspace.trim() is not correctly removing relationships when the destination of a relationship is removed from the workspace HOT 1
- Implied relationships for some filtered views aren't rendered HOT 2
- Groovy interop call yields illegal argument exception from DSL - using CLI, works from test HOT 5
- !include doesn't work with files encoded as UTF-8 BOM HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from java.