arc42.org-site
json-schema-spec
arc42.org-site | json-schema-spec | |
---|---|---|
16 | 32 | |
6 | 3,279 | |
- | 4.7% | |
7.9 | 7.9 | |
19 days ago | 5 days ago | |
SCSS | JavaScript | |
MIT License | GNU General Public License v3.0 or later |
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.
arc42.org-site
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
-
Architecture diagrams enable better conversations
I've been using https://structurizr.com/ to automatically generate C4 diagrams from a model (rather than drawing them by hand). It works well with the approach for written documentation as proposed in https://arc42.org/. It's very easy to embed a C4 diagram into a markdown document.
The result is a set of documents and diagrams under version control that can be rendered using the structurizr documentation server (for interactive diagrams and indexed search).
I also use https://d2lang.com/ for declarative diagrams in addition to C4, e.g., sequence diagrams and https://adr.github.io/ for architectural decision records. These are also well integrated into structurizr.
-
Documenting a software project
My general approach to documentation is a "software guidebook" (free e-book link) or arc42 ... complemented with diagrams and architecture decision records where necessary.
-
System Design How to?
In addition to a small number of diagrams, I'd recommend something like arc42 or my "software guidebook" (link for a free copy of my book describing this), plus some architecture decision records.
-
Solution Templates
Arc42 may give some inspiration https://arc42.org/
-
What's your process to create documentation for a new startup's application?
If you need more structure than ADRs then https://arc42.org is super useful.
-
Recommendations for an Online Introduction to Software Modeling
There are plenty of good resources out there for learning modeling languages and architectural documentation structures. For more lightweight methods, I'd recommend checking out resources like Simon Brown's C4 model for visualizing software architecture, Martin Fowler's UML Distilled: A Brief Guide to the Standard Object Modeling Language, Scott Ambler's Agile Modeling site, and the arc42 template for architectural documentation.
-
How to get good at writing design documents?
As you need to, you can get into topics like different modeling languages or documentation template libraries. These are going to be highly dependent on your organization, though, as different organizations have different standards for what and how to document design decisions. Personally, I've found that the arc42 documentation template plus the C4 modeling language plus the UML modeling language (see UML as sketch and UML as notes for more on lightweight UML) for the most detailed models (which are rarely needed outside of the most complex parts of a system) tends to be a good, agile, lightweight model for the kinds of things to think about when it comes to creating design documentation.
-
How to improve writing documentation?
We've started using Arc42 and C4 model & PlantUML for diagrams. Working out well so far.
-
About documentation
arc42 - arc42
json-schema-spec
- Python JSON schema
-
TypeSpec: A New Language for API-Centric Development
Yep and that comes from JSON Schema: https://json-schema.org/
I believe recent versions of OpenAPI are "compatible" with JSON Schema (at least they "wanted to be" last I checked as I was implementing some schema converters).
Even TypeScript is not enough to represent all of JSON Schema! But it gets close (perhaps if you remove validation rules and stuff like that it's a full match).
But even something like Java can represent most of it pretty well, specially since sealed interfaces were added. I know because I've done it :).
- JSON Schema Blog
-
Deploy a simple data storage API with very little code using Amazon API Gateway and DynamoDB
models.tf where I centralized all the Data model that API Gateway uses to perform input and output checks. Those use the JSON-schema specification. GitHub - psantus/serverless.api-gateway-dynamodb-integration.terraform
- Unlocking the frontend – a call for standardizing component APIs pt.2
- JSON Schema
-
How to Automatically Consume RESTful APIs in Your Frontend
In the meantime, we are going to expand our backend with two endpoints: one for fetching data and another one for creating data. Fastify provides out-of-the-box support for API serialization and validation through its schema-based approach built on top of JSON Schema. Through the schema option, we can attach a schema definition to each route.
-
A View on Functional Software Architecture
JSON-schema to define templates for request and response contents.
-
Learn serverless on AWS step-by-step: Strong Types!
The syntax used to define the output is called JSON Schema. It is a standard way to define the structure of a JSON object. If you know zod, the spirit is similar. Based on Swarmion's roadmap, it will be possible to use zod schemas to defined contracts in the future, which will be super cool!
- XML is better than YAML
What are some alternatives?
diataxis-documentation-framework - A systematic approach to creating better documentation.
outlines - Structured Text Generation
jgmd - A directory of direct links to get your personal data from web services.
guidance - A guidance language for controlling large language models.
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
uplaybook - A python-centric IT automation system.
architecture_decision_record - Architecture decision record (ADR) examples for software planning, IT leadership, and template documentation
nix-configs - My Nix{OS} configuration files
architecture-decision
OpenAPI-Specification - The OpenAPI Specification Repository
java - Structurizr for Java
torch-grammar