swagger-ui
C4-PlantUML
| swagger-ui | C4-PlantUML | |
|---|---|---|
| 145 | 26 | |
| 26,661 | 6,444 | |
| 0.6% | 1.0% | |
| 9.5 | 6.7 | |
| 14 days ago | about 1 month ago | |
| JavaScript | PlantUML | |
| Apache License 2.0 | 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-ui
-
How to Create a RESTful API with Node.js: A Step-by-Step Guide
Good documentation is vital for any API. Consider using tools like Swagger or Postman to create interactive documentation.
- Implement swaggo
-
11 API Documentation Best Practices for CI/CD 2024
1. Use tools like Swagger or Postman to auto-generate docs
-
Open API specs with more than one YAML file
This project also comes with an index.html that can be served statically and it also interacts with the Swagger UI official bundle that is contained inside the dist folder.
-
A Guide to Top API Testing Tools in 2024
Website: https://swagger.io
-
🚀 Introducing NextSolution V2: ASP.NET API + Next.js + Expo Starter Template
This template was built using a variety of powerful frameworks and tools, including: .NET, Ngrok, JWT (JSON Web Tokens), Entity Framework, AutoMapper, FluentValidation, Flurl, Humanizer, libphonenumber-csharp, MailKit, OAuth, Serilog, Twilio, Swagger, React.js, React Native, React Navigation, Axios, Expo Dev, Lodash, NativeWind, React Hook Form, Zustand, Visual Studio Code, Visual Studio, Android Studio, Git, GitHub Copilot, Node.js, React Native Paper, NextUI
-
Hosting Swagger-UI using GitHub Pages
curl -X GET https://github.com/swagger-api/swagger-ui/releases/tag/v5.17.14
-
Everything You Need To Know About Living Documentation
Automated Documentation Generators: Tools like Swagger for APIs, Javadoc for Java, and Sphinx for Python automatically generate documentation based on code annotations, comments, or metadata.
-
Rest API Testing: How to test Rest APIs properly!
An API is like a contract between a client and a server or between two applications. Before testing the implementation, it must be ensured that the contract is correct by checking the specification (e.g. Swagger or OpenAPI). For Rest APIs, it is important that all HTTP REST semantics and principles are adhered to. This is all the more important for publicly accessible APIs so that all functionalities can continue to be guaranteed after updates.
-
swagger-ui VS doc2html - a user suggested alternative
2 projects | 25 Jul 2024
C4-PlantUML
- C4 Model - The Basics
-
Vega – A declarative language for interactive visualization designs
What sort of maps are you wanting to build? https://c4model.com/ seems to be the more popular standard for this style at the moment. https://github.com/plantuml-stdlib/C4-PlantUML makes this somewhat easy to code out. (And I think most cloud providers have addons for it.)
-
Ask HN: Guidelines for making clear architecture diagrams
Third this. Don't look any further, just do it!
Also, PlantUML + C4 is like peanut butter & jelly:
https://github.com/plantuml-stdlib/C4-PlantUML
I'll gladly give up control of layout, and accept some ugliness, to never again have to worry about dragging boxes and arrows to be pixel-aligned, and then do it all over again when I add another box...
It looks like Mermaid has C4 support too:
https://mermaid.js.org/syntax/c4.html
-
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:
- https://github.com/plantuml-stdlib/C4-PlantUML
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
- What FOSS programs would you recommend for creating concept maps on Linux?
What are some alternatives?
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
ReDoc - 📘 OpenAPI/Swagger-generated API Reference Documentation [Moved to: https://github.com/Redocly/redoc]
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation
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.
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
prism - Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.
backstage - Backstage is an open framework for building developer portals
drf-spectacular - Sane and flexible OpenAPI 3 schema generation for Django REST framework.
dsl - Structurizr DSL