C4-PlantUML
swagger-ui
Our great sponsors
C4-PlantUML | swagger-ui | |
---|---|---|
23 | 130 | |
5,948 | 25,384 | |
2.0% | 1.1% | |
7.1 | 9.8 | |
6 days ago | 6 days ago | |
PlantUML | JavaScript | |
MIT License | Apache License 2.0 |
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.
C4-PlantUML
-
Documentation as Code for Cloud - C4 Model & Structurizr
C4-PlantUML: Export your model as C4-PlantUML diagrams.
-
Which tools do you use to create diagrams?
PlantUML + C4 plugin;
-
Add quick sketches in emacs org mode
Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)
-
Architecture diagrams should be code
The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
-
C4 model for system architecture design
3️⃣ Text-based diagramming- C4-PlantUML
-
Ask HN: Confluence Alternative(s) Supporting Markdown?
> onboarding docs
yes, they're don't changing frequently
> system design docs
yes - see C4-PlantUML[1]
> meeting notes
no, unless they're directly code related like ADRs [2,3].
Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.
--
[1] https://github.com/plantuml-stdlib/C4-PlantUML
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
-
Do you take physical notes while working on your game? Or just play around and learn by doing?
I use a combination of: * Markdown (for notes and code blocks) * Mermaid markdown (for architectural diagrams in markdown documents) * PlantUML markdown (again for arch. docs in markdown, but mainly for C4 diagrams) * a Docker container to render PlantUML markdown to images * Joplin, installed on every device I regularly use * NextCloud, to store, secure, encrypt, and make available everywhere, the markdown notes managed by Joplin
- Diagram as Code
swagger-ui
-
Open API with Postman
The API had an OpenAPI endpoint built with Swagger where I could download a JSON specification file for the API.
-
Best Software Documentation Tools
Swagger is a widely used tool for documenting and testing APIs.
-
How to Automatically Consume RESTful APIs in Your Frontend
Swagger is an open-source software framework that implements the OpenAPI Specification—an API description format for REST APIs. The OpenAPI Specification defines a standard, language-agnostic interface to HTTP APIs, enabling both humans and computers to discover and understand the capabilities of the API.
-
Embracing API-First Development: Building the Future of Software
Mocking and Testing: Once the API design is complete, developers create mock APIs to simulate the behavior of the actual services. This early testing phase helps identify any issues or mismatches between design and implementation before substantial development efforts are invested. Tools like Postman or Swagger are invaluable for API testing and validation.
-
Craft OpenAPI Specs & Production-Ready SDKs with Fastify
import fp from "fastify-plugin"; import swagger from "@fastify/swagger"; export default fp(async (fastify) => { fastify.register(swagger, { openapi: { info: { tags: [ { name: "drinks", description: "Drink-related endpoints", externalDocs: { description: "Find out more", url: "http://swagger.io", }, }, ], }, }, }); });
- Como deixar o Swagger com tema dark mode usando NestJS
-
ChatGPT: how I used it to convert HTTP requests to OpenAPI document
A very requested feature for Sharkio was the auto-generation of OpenAPI documentation using the recorded HTTP requests - to create standardized documentation.
-
What do people with a degree in computer science do at work?
Automation QA is a lot of the same duties as manual QA, but instead of writing and executing the test plans manually, we create and update automated tests that can run those validations programmatically, for example by using Selenium to automatically fill out and submit forms for a web application, or using Postman and/or Swagger to generate an API conversation test.
-
what do you find most frustrating about dotnet?
The code below is now roughly from memory and my controller would usually look something like this (Swashbuckle or NSwag attribute hints removed). There are some gotchas with Swagger and SwaggerUI for supporting multipart/form-data which I haven't included here since they now be fixed, since it's been a while since I checked.
-
Generating an OpenAPI/Swagger spec from a Ruby on Rails API
rswag also includes a bundled version of Swagger UI if you want to inspect your OpenAPI spec visually during testing.
What are some alternatives?
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
ReDoc - 📘 OpenAPI/Swagger-generated API Reference Documentation [Moved to: https://github.com/Redocly/redoc]
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
fiber-swagger - fiber middleware to automatically generate RESTful API documentation with Swagger 2.0.
prism - Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
backstage - Backstage is an open platform for building developer portals