sig-moonwalk
http-spec
sig-moonwalk | http-spec | |
---|---|---|
6 | 18 | |
250 | 19 | |
5.2% | - | |
6.0 | 6.1 | |
about 1 month ago | 14 days ago | |
TypeScript | ||
Apache License 2.0 | 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.
sig-moonwalk
- OpenAPI v4 (aka Moonwalk) Proposal
-
OpenAPI v4 Proposal
One of the Moonwalk discussions is indeed about moving from objects to arrays for many structures: https://github.com/OAI/moonwalk/discussions/32
Also, I agree with the person who mentioned JSON Patch (RFC 6902), which I feel is an under-rated and underused technology. While less intuitive than JSON Merge Patch (RFC 7396), it is far more powerful. I have used both together, using JSON Merge Patch where possible to keep things more readable and intuitive, and using JSON Patch where JSON Merge Patch can't do what is needed. Although if most of your changes need JSON Patch, I find it's better to just stick with that.
-
OpenAPI 3.1 - The Gnarly Bits
Why not get involved in the discussions around a tentative OpenAPI 4.0, codename 'Moonwalk'?
http-spec
- The most effective Schema-Driven Development using OpenAPI for Logistic Engineer
- Spotlight: Sentry for Development
-
Testing an OpenAPI specification in PHP
However, we do not need to write the specification by hand, as there are GUI editors to perform that task. We show a couple of examples of Spotlight, which provides an easy-to-use interface:
-
Rapid Prototyping of Design-First APIs in Go
We use Stoplight Studio https://stoplight.io/ to design APIs, one of the advantages of Stoplight Studio is the Visual interface, it generates OpenAPI specs from the design and supports OpenAPI v3, allowing users to create, edit, and view API designs using the OpenAPI standard.
-
OpenAPI v4 Proposal
I'm sorry, but you have completely misunderstood the purpose of Open API.
It is not a specification to define your business logic classes and objects -- either client or server side. Its goal is to define the interface of an API, and to provide a single source of truth that requests and responses can be validated against. It contains everything you need to know to make requests to an API; code generation is nice to have (and I use it myself, but mainly on the server side, for routing and validation), but not something required or expected from OpenAPI
For what it's worth, my personal preferred workflow to build an API is as follows:
1. Build the OpenAPI spec first. A smaller spec could easily be done by hand, but I prefer using a design tool like Stoplight [0]; it has the best Web-based OpenAPI (and JSON Schema) editor I have encountered, and integrates with git nearly flawlessly.
2. Use an automated tool to generate the API code implementation. Again, a static generation tool such as datamodel-code-generator [1] (which generates Pydantic models) would suffice, but for Python I prefer the dynamic request routing and validation provided by pyapi-server [2].
3. Finally, I use automated testing tools such as schemathesis [3] to test the implementation against the specification.
[0] https://stoplight.io/
[1] https://koxudaxi.github.io/datamodel-code-generator/
[2] https://pyapi-server.readthedocs.io
[3] https://schemathesis.readthedocs.io
- Swagger Hub alternatives
-
Examples of API Governance?
One of the best tools out there for API design and governance https://stoplight.io/ you can also use the open source tool (also from Stoplight) called Spectral https://stoplight.io/open-source/spectral
-
Review: 10 Top API Mock Tools
Stoplight is a platform for designing, documenting, and testing APIs. Its "Mocks" feature allows you to create mock versions of your API for testing and development purposes. In addition to the mock feature, Stoplight also includes tools for API design, documentation, and testing, making it a comprehensive platform for API development.
-
💰 My Frugal Indie Dev Startup Stack
Stoplight
-
API Product Managers vs. API Developers
JSON visualizer JSON validator YAML validator Collaborative Design & Documentation for APIs
What are some alternatives?
fern - 🌿 Stripe-level SDKs and Docs for your API
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
postcat - Postcat 是一个可扩展的 API 工具平台。集合基础的 API 管理和测试功能,并且可以通过插件简化你的 API 开发工作,让你可以更快更好地创建 API。An extensible API tool.
effect-http - Declarative HTTP API library for effect-ts
OneSDK - 1️⃣ One Node.js SDK for all the APIs you want to integrate with
oatx - Generator-less JSONSchema types straight from OpenAPI spec
swag - Automatically generate RESTful API documentation with Swagger 2.0 for Go.
hoverfly - Lightweight service virtualization/ API simulation / API mocking tool for developers and testers
speakeasy - Speakeasy CLI - Enterprise developer experience for your API
rest-api-standards - An open collection of REST API standards documents