swagger-cli
bpmnlint
swagger-cli | bpmnlint | |
---|---|---|
2 | 1 | |
513 | 118 | |
- | 0.0% | |
0.0 | 8.1 | |
almost 2 years ago | about 2 months ago | |
JavaScript | JavaScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
swagger-cli
-
TypeSpec: A New Language for API-Centric Development
If you are in a situation where you have a backend and you want to expose an API and then you would eventually want a client, you would need format specs as the starting point where server and clients are generated from that one source.
At the moment, OpenAPI with YAML is the only way to go but you can't easily split the spec into separate files as you would do any program with packages, modules and what not.
There are third party tools[0] which are archived and the libraries they depend upon are up for adoption.
In that space, either you can use something like cue language 1] or something like TypeSpec which is purpose built for this so yet, this seems like a great tool although I have not tried it yet myself.
[0]. https://github.com/APIDevTools/swagger-cli
[1]. https://cuelang.org/
EDIT: formating
-
Generating docs from OpenAPI Spec
In order to use Redocusaurus, I needed a single spec file. Both Swagger cli and OpenApi cli offered an option to merge separate specs into one. The problem was that one of them required a "root spec file" to drive the merging and the other required extra information to resolve conflicts. My specs had neither.
bpmnlint
-
What do you use to visualise user flows, data and tell a story?
We needed specialist subject matter experts in the domain to design the workflows working with behavioral science experts to author the payload text in each message. But getting a BPMN diagram into a final, computable form that passes validation checked (aka linting) requires software engineering skills and so we started out with the SME drawing an initial BPMN in Camunda’s web tool then the engineer pulls the into Camunda Modeler to do their part to make the workflow executable. The diagrams are in source control and version control is vitally important as we gathered feedback and tweaked the behavior of the system to do a better job of nudging the behavior of the humans it was interacting with.
What are some alternatives?
widdershins - OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
butterfly - 🦋Butterfly,A JavaScript/React/Vue2 Diagramming library which concentrate on flow layout field. (基于JavaScript/React/Vue2的流程图组件)
redocly-cli - ⚒️ Redocly CLI makes OpenAPI easy. Lint/validate to any standard, generate beautiful docs, and more.
bpmn-js - A BPMN 2.0 rendering toolkit and web modeler.
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
kroki - Creates diagrams from textual descriptions!
swagger-markdown - swagger to markdown transpiler
fast-xml-parser - Validate XML, Parse XML and Build XML rapidly without C/C++ based libraries and no callback.
openapi - An OpenAPI specification for the Stripe API.
fluent-json-validator - An easy-to-use, expressive, and composable JSON object validator, with a fluent builder pattern interface!
thai-citizen-id-validator - 🇹🇭 Thai Citizen ID validator with zero dependencies
validator-benchmark - JS validators benchmark