https://pb33f.io/ Recent content on pb33f: enterprise grade software for hackers and engineers Hugo 0.125.2 en-us Sun, 03 May 2026 19:20:58 -0400 https://pb33f.io/wiretap/multi-spec-mode/ Sun, 03 May 2026 03:00:00 -0400 https://pb33f.io/wiretap/multi-spec-mode/ One proxy, many contracts wiretap can load many OpenAPI specifications at the same time and route each incoming request to the contract that owns it. We call this multi-spec mode. Real systems are rarely described by a single OpenAPI contract. Services each ship their own spec, API gateways stitch together specs from multiple backends/polyrepos, and monorepos collect dozens of contracts in one tree. multi-spec mode lets wiretap validate traffic across all of them, without having to merge or pre-process the contracts first. https://pb33f.io/newsletters/april-2026/ Thu, 23 Apr 2026 04:59:17 -0500 https://pb33f.io/newsletters/april-2026/ view this newsletter on the web. A SEASON FOR HACKING Howdy, my fellow hackers, Spring is beautiful here at the pb33f ranch at the moment. The grass is green, and the foliage is fresh and youthful. Everything is also covered in a thick layer of yellowish-green pollen. It doesn’t help that our ranch is in a forest. A megaton of hackery has been going on. Let me catch you up. https://pb33f.io/openapi-changes/version/ Mon, 13 Apr 2026 10:45:00 -0400 https://pb33f.io/openapi-changes/version/ The version command prints only the raw build version string. It is useful for install verification, scripts, and CI checks. Examples: openapi-changes version docker run --rm pb33f/openapi-changes version The output is intentionally minimal: v0.2.1 https://pb33f.io/openapi-changes/completion/ Wed, 08 Apr 2026 09:00:00 -0400 https://pb33f.io/openapi-changes/completion/ The completion command generates shell completion scripts for bash, zsh, fish, and powershell. Examples: openapi-changes completion zsh openapi-changes completion bash If you need the exact shell integration help text, run: openapi-changes completion --help https://pb33f.io/openapi-changes/markdown-report/ Wed, 08 Apr 2026 09:00:00 -0400 https://pb33f.io/openapi-changes/markdown-report/ Use markdown-report when you want a shareable file instead of a terminal session. It renders the semantic change report as markdown, which makes it useful for pull requests, release notes, and internal docs. Examples: openapi-changes markdown-report ./ sample-specs/petstorev3.json openapi-changes markdown-report HEAD~1:openapi.yaml ./openapi.yaml Useful flags Write to a specific file Use --report-file to choose the output filename. openapi-changes markdown-report --report-file changes.md ./ sample-specs/petstorev3.json Include the raw unified diff Use --include-diff to append a collapsible unified diff of the raw spec for each commit. https://pb33f.io/libopenapi/arazzo/ Thu, 26 Feb 2026 10:00:00 -0500 https://pb33f.io/libopenapi/arazzo/ The Arazzo Specification defines a standard way to describe sequences of API calls as workflows. Arazzo documents reference OpenAPI specifications and describe step-by-step orchestrations on which operations to call, in what order, how to pass data between them, and what constitutes success or failure. libopenapi provides full support for: Parsing Arazzo 1.0.1 documents into strongly-typed Go models Validating documents against 21 structural rules with line/column error reporting Executing workflows via a pluggable engine with retry, branching, and dependency ordering Arazzo support was added in libopenapi v0. https://pb33f.io/libopenapi/overlays/ Tue, 23 Dec 2025 10:00:00 -0500 https://pb33f.io/libopenapi/overlays/ The OpenAPI Overlay Specification defines a standard way to modify OpenAPI documents without editing the original files. Overlays are useful for: Environment-specific customization - Different server URLs for dev/staging/prod API versioning - Removing deprecated operations for newer API versions Partner customization - Tailoring documentation for specific integrations Documentation updates - Adding descriptions without modifying source specs SDK Generation - Add extensions to customize code generation Overlay support was added in libopenapi v0. https://pb33f.io/openapi-changes/configuring/ Sat, 13 Dec 2025 10:00:00 -0500 https://pb33f.io/openapi-changes/configuring/ Not every change that could be breaking is breaking for your own API. openapi-changes lets us customize which changes are flagged as breaking, so we can tailor the rules to match our API’s versioning strategy and consumer expectations. This feature is available from v0.0.91 We have dropped all support for Swagger moving forward. It’s a commercial tool that uses a different standard to OpenAPI. This only works with OpenAPI Documents. https://pb33f.io/newsletters/dec-2025/ Thu, 04 Dec 2025 05:59:17 -0500 https://pb33f.io/newsletters/dec-2025/ view this newsletter on the web. Christmas is coming, oh no. Howdy, my fellow hackers, It’s cold outside; well, it is here in pb33f HQ in Virginia anyway. I wanted to let you know what’s been cooking down here on the ranch. I hope you’re well and having fun and staying warm. The holiday season is upon us, get ready for chaos, and hopefully some downtime with family and loved ones. https://pb33f.io/newsletters/sept-2025/ Thu, 18 Sep 2025 07:59:17 -0500 https://pb33f.io/newsletters/sept-2025/ view this newsletter on the web. 🏫 Back to school! Howdy, my fellow hackers, By now, all the kids are back in school (like mine), and everyone is recovering after a fun-filled summer full of beach trips, sunshine, and conferences! I wanted to let you know about what’s been cooking on the ranch. I hope you’re well and having fun. vacuum gets a facelift NEW! Recently, my addiction to Claude Code took yet another dive, and after five hazy code-fueled days, I ended up rebuilding the entire terminal UI for vacuum. https://pb33f.io/newsletters/july-2025/ Mon, 21 Jul 2025 07:59:17 -0500 https://pb33f.io/newsletters/july-2025/ 🚀 Workspaces available! Howdy folks, Hope you’re having a great summer. If you have young kids at home (like me), I’m sorry. Over the last couple of weeks, we very quietly launched the ability to authenticate with pb33f, and over the weekend NEW! workspaces went live in the doctor. 🔐 OAuth Only We don’t want to hold your passwords, so to authenticate, you will need to use a service provider. We’re starting with GitHub, but plan on adding more soon. https://pb33f.io/wiretap/har-files/ Sat, 13 Jan 2024 07:08:04 -0500 https://pb33f.io/wiretap/har-files/ use wiretap offline with HAR files HTTP Archive (HAR) files can be loaded into wiretap for review in the Monitor UI, or for validation against an OpenAPI specification. Reviewing the HAR files By loading in a HAR file and loading the Monitor UI you can review the captured traffic. The UI will stream the traffic to you as if it were being sent live, and you can use the UI to filter the traffic, or to search for anything specific. https://pb33f.io/wiretap/headless-mode/ Sat, 13 Jan 2024 07:08:04 -0500 https://pb33f.io/wiretap/headless-mode/ Avoid the Monitor UI To use wiretap as a part of a pipeline or to integrate it into your CI/CD process, you can run wiretap in headless mode. This will run wiretap as normal, except the violations that are captured will be streamed to a file. This is in addition to being streamed to the monitor UI. Use the --stream-report / a flag to stream violations to a file: wiretap --stream-report -u https://api. https://pb33f.io/libopenapi/changelog/ Wed, 10 Jan 2024 10:15:03 -0500 https://pb33f.io/libopenapi/changelog/ Everything that has changed in the last 20 releases of libopenapi. loading changelog component... view more on github > https://pb33f.io/openapi-changes/changelog/ Wed, 10 Jan 2024 10:15:03 -0500 https://pb33f.io/openapi-changes/changelog/ Everything that has changed in the last 20 releases of openapi-changes loading changelog component... view more on github > https://pb33f.io/wiretap/changelog/ Wed, 10 Jan 2024 10:15:03 -0500 https://pb33f.io/wiretap/changelog/ Everything that has changed in the last 20 releases of wiretap loading changelog component... view more on github > https://pb33f.io/libopenapi/rolodex/ Mon, 20 Nov 2023 05:10:13 -0500 https://pb33f.io/libopenapi/rolodex/ This documentation only applies to v0.13+ of libopenapi. In all releases before then the index and resolver architecture was significantly different and the behavior and relationship of them was also different. If you have ever used OpenAPI with golang, you’re probably aware of using $ref to reference other objects like Schemas or Parameters that we want to re-use across a specification, or across multiple specifications. libopenapi needs a way to look up these references and resolve them. https://pb33f.io/libopenapi/mocks/ Mon, 04 Sep 2023 07:38:08 -0500 https://pb33f.io/libopenapi/mocks/ A quick example Using the burger shop testing OpenAPI specification, we can generate a mock from one of the examples in Fries component schema. import ( "fmt" "github.com/pb33f/libopenapi" "github.com/pb33f/libopenapi/renderer" "os" ) func renderFries() { // create a new JSON mock generator mg := renderer.NewMockGenerator(renderer.JSON) // tell the mock generator to pretty print the output mg.SetPretty() burgerShop, _ := os.ReadFile("burgershop.openapi.yaml") // create a new document from specification and build a v3 model. https://pb33f.io/wiretap/mock-responses/ Sat, 02 Sep 2023 14:51:04 -0500 https://pb33f.io/wiretap/mock-responses/ Please enter the simulation wiretap can be used as a full simulation of a real API. We call it mock mode. To enable it, use the -x or the --mock-mode flags when running wiretap with an OpenAPI Specification. wiretap -s giftshop-openapi.yaml -u https://api.pb33f.io -x Try before you buy mock mode simulates a real, working web API by using an OpenAPI contract to simulate the responses to API calls. The simulation is based on the OpenAPI contract, which means the API will be contractually correct, ideal for testing and development. https://pb33f.io/wiretap/contributing/ Tue, 08 Aug 2023 12:51:04 -0500 https://pb33f.io/wiretap/contributing/ wiretap is an open source project licenced under BUSL 1.1, and we welcome contributions from the community. Guidelines There are currently very few tests in this project, so we ask that you please write tests for any new code, so we can start to build up a test suite. How to develop locally Wiretap is written in go, it uses libopenapi as the underlying OpenAPI library and ranch as the underlying web/API framework. https://pb33f.io/wiretap/giftshop-api/ Sun, 30 Jul 2023 02:51:04 -0500 https://pb33f.io/wiretap/giftshop-api/ The Giftshop API In order to try out wiretap, we’ve created a small demo API that you can use to play around with. The API is a simple giftshop API that has a few sample endpoints. The API cannot be damaged in any way, so feel free to try out any of the features of wiretap on it. No mutations will be persisted, nothing will be deleted, and no data will be lost. https://pb33f.io/wiretap/monitor/ Tue, 11 Jul 2023 07:08:04 -0500 https://pb33f.io/wiretap/monitor/ A window into your API Open up your browser and point it at http://localhost:9091, (or which ever port you have configured ) and you should see the wiretap monitor. The main components of wiretap outlined Transaction area Select a transaction from the list to view the request, response and any violations that may have been fired. The main components of wiretap outlined indicates that a global delay was applied to the transaction. https://pb33f.io/wiretap/configuring/ Mon, 10 Jul 2023 15:51:04 -0500 https://pb33f.io/wiretap/configuring/ Using flags The following flags exist for configuring wiretap: Flag Short Code Description –url -u Set the redirect URL for wiretap to send traffic to [required] –port -p Set port on which to listen for HTTP traffic (default is 9090) –monitor-port -m Set port on which to serve the monitor UI (default is 9091) –ws-port -w Set port on which to serve the monitor UI websocket (default is 9092) –spec -s Set the path to the OpenAPI specification to use –static -t Set the path to a directory of static files to serve –static-index -i Set the index filename for static file serving (default is index. https://pb33f.io/wiretap/quickstart/ Mon, 10 Jul 2023 05:38:08 -0500 https://pb33f.io/wiretap/quickstart/ Don’t have time to read? Just want to try things out? No problem, we’ve got you covered. 1. Install wiretap brew install pb33f/taps/wiretap If you don’t/can’t use homebrew, then you can use one of the other methods of installing wiretap 2. Download OpenAPI spec We’re going to use a small example Gift Shop OpenAPI specification to demonstrate the speed and power of wiretap. curl -o giftshop-openapi.yaml https://api.pb33f.io/wiretap/giftshop-openapi.yaml 3. Run wiretap wiretap -s giftshop-openapi. https://pb33f.io/wiretap/about/ Sat, 08 Jul 2023 18:08:04 -0500 https://pb33f.io/wiretap/about/ Three goals wiretap has three main goals as a tool: Validate API requests and responses are compliant with OpenAPI specifications. Operate as a development server for UIs to test APIs. Provide diagnostics for developers to debug API requests and responses. Why does wiretap exist? When looking for solutions to validate brownfield servers and clients were actually compliant with an OpenAPI specification, we found nothing that didn’t require infrastructure and didn’t require code changes. https://pb33f.io/wiretap/installing/ Sat, 08 Jul 2023 18:08:04 -0500 https://pb33f.io/wiretap/installing/ Using homebrew The easiest way to install wiretap is to use homebrew if you’re on OSX or Linux. We have our own tap available that gives the latest and greatest version. brew install pb33f/taps/wiretap Using npm or yarn Building a JavaScript / TypeScript application? No problem, grab your copy of wiretap using your preference of yarn or npm. yarn global add @pb33f/wiretap npm install -g @pb33f/wiretap Using cURL Do you want to use wiretap in a linux only or CI/CD pipeline or workflow? https://pb33f.io/wiretap/static-content/ Sat, 08 Jul 2023 18:08:04 -0500 https://pb33f.io/wiretap/static-content/ When building a user interface to an API, it may mean that in order to effectively test the API, you need to serve some static content or files along with the API. Why do I need this? If the user interface is a web application, and the web application and the API are served from the same host, then in order to effectively use wiretap, the application would need to be served by wiretap as well. https://pb33f.io/company/about/ Sat, 27 May 2023 09:29:48 -0400 https://pb33f.io/company/about/ What are we? We’re Princess Beef Heavy Industries (or as we call it ‘pb33f’), we build beautifully designed heavy-duty and enterprise grade software for code hackers and software engineers. We’re highly experienced misfit engineers, who want to bring the power of big tech, to the rest of us. When we say ‘we’. It’s just ‘me’ (Quobix). Well, me and my OSS friends, sponsors and contributors. Why do we exist? After years of suffering through the use of poorly designed, buggy and slow tools, it was time to do something about it. https://pb33f.io/company/manifesto/ Sat, 27 May 2023 09:29:48 -0400 https://pb33f.io/company/manifesto/ Foundation In 2011, Marc Andreessen said, “software is eating the world.” In 2023, AWS, Netflix, Shopify, Airbnb, Hashicorp, and a thousand other examples in the market demonstrated this reality. The value we can create through software is limitless. To develop good software, we need good software Developers, Engineers, Coders, Hackers, Architects or what ever your preferred title is. Generally, the tools and materials used to make a product determine the quality of the product outcome. https://pb33f.io/discord/ Sat, 27 May 2023 09:28:42 -0400 https://pb33f.io/discord/ no sdsdsd https://pb33f.io/libopenapi/validation/ Sun, 23 Apr 2023 09:37:32 -0400 https://pb33f.io/libopenapi/validation/ Get libopenapi-validator The first step to validation, is to get the libopenapi-validator module added to the project, validation does not come with libopenapi as a core module. libopenapi-validator depends on github.com/santhosh-tekuri/jsonschema as the validation engine for schemas. This dependency is only required for validation and not for the core libopenapi library to operate. To avoid having folks import dependencies that are only used for a certain capability, we have kept validation as an opt-in feature, if the host application requires it. https://pb33f.io/libopenapi/modifying/ Wed, 22 Mar 2023 06:20:33 -0500 https://pb33f.io/libopenapi/modifying/ Until v0.7.0 the library was optimized for reading. With the introduction of v0.7.0 the porcelain layer is now Renderable. Any changes made to the high-level can now be captured when ‘rendering’ the model to YAML or JSON. We made a conscious choice to only build this functionality into the OpenAPI 3+ model and NOT the Swagger model. This is because We’re not actively developing the Swagger model, and we don’t want to encourage people to use it. https://pb33f.io/openapi-changes/demo/ Fri, 03 Feb 2023 09:13:36 -0500 https://pb33f.io/openapi-changes/demo/ https://pb33f.io/openapi-changes/summary/ Mon, 30 Jan 2023 10:38:08 -0500 https://pb33f.io/openapi-changes/summary/ The summary command prints a concise semantic overview of what changed. It is the quickest way to inspect a diff in the terminal or wire openapi-changes into CI. Examples: openapi-changes summary ./ sample-specs/petstorev3.json openapi-changes summary HEAD~1:openapi.yaml ./openapi.yaml You should see something like this: Useful flags Markdown output Use --markdown to render the summary as markdown. This is useful in CI logs, issue comments, and release notes. openapi-changes summary --markdown ./ sample-specs/petstorev3. https://pb33f.io/openapi-changes/quickstart/ Mon, 30 Jan 2023 05:38:08 -0500 https://pb33f.io/openapi-changes/quickstart/ If you want the fastest path from install to useful output, this page is it. 1. Install openapi-changes brew install pb33f/taps/openapi-changes If you do not use Homebrew, see the other installation options. 2. Generate an HTML report Use the OpenAPI Petstore fixture hosted on GitHub to generate the interactive report: openapi-changes html-report https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.0/petstore.yaml This writes report.html into your working directory. 3. Open the report open report.html 4. Explore the same data in the console openapi-changes console https://github. https://pb33f.io/openapi-changes/command-arguments/ Mon, 30 Jan 2023 04:38:08 -0500 https://pb33f.io/openapi-changes/command-arguments/ openapi-changes exposes seven commands: Console Summary Report Markdown Report HTML Report Completion Version The five comparison/reporting commands all use the same doctor-based comparison engine and accept the same input shapes. The utility commands are different: completion generates shell completion scripts version prints the raw build version string Supported input modes Local git repository history If the OpenAPI spec lives in a local git repository, pass two arguments: the path to the git repository the path to the OpenAPI spec inside the repository If the full path to a spec is /home/pb33f/corp-code/specs/v3/openapi. https://pb33f.io/openapi-changes/console/ Mon, 30 Jan 2023 04:38:08 -0500 https://pb33f.io/openapi-changes/console/ The console command opens the interactive terminal UI for browsing changes across revisions. Examples: openapi-changes console ./ sample-specs/petstorev3.json openapi-changes console HEAD~1:openapi.yaml ./openapi.yaml You should see something like this: Keyboard controls At any point, press Ctrl-C or q to quit. Escape steps back through the current view and returns focus to the previous panel or closes the current overlay. The console has three main panels: commit history semantic change tree diff view The usual flow is: https://pb33f.io/openapi-changes/html-report/ Mon, 30 Jan 2023 04:38:08 -0500 https://pb33f.io/openapi-changes/html-report/ The html-report command generates a self-contained interactive HTML report that works offline. It is the richest way to explore the semantic diff in a browser. Examples: openapi-changes html-report ./ sample-specs/petstorev3.json && open report.html openapi-changes html-report HEAD~1:openapi.yaml ./openapi.yaml && open report.html You should see something like this: Useful flags Write to a different file Use --report-file to choose a different output filename. openapi-changes html-report --report-file changes.html ./ sample-specs/petstorev3.json Exclude the explorer graph Use --no-explorer if you want a smaller output bundle and do not need the explorer graph tab. https://pb33f.io/openapi-changes/report/ Mon, 30 Jan 2023 04:38:08 -0500 https://pb33f.io/openapi-changes/report/ Use report when you want a machine-readable JSON representation of the detected changes instead of a terminal or browser view. Examples: openapi-changes report ./ sample-specs/petstorev3.json | jq openapi-changes report HEAD~1:openapi.yaml ./openapi.yaml | jq jq is only used here to pretty-print the JSON. If you do not have it installed, remove the pipe and print the raw JSON directly. You should see something like this: When to use report Use report when another tool needs structured JSON. https://pb33f.io/libopenapi/faq/ Sun, 29 Jan 2023 10:15:03 -0500 https://pb33f.io/libopenapi/faq/ In case you have any questions about libopenapi, here are some common questions and answers. Q: Does it provide validation? Answer: Yes! We created a new module called the libopenapi-validator. Q: Does it support relative and remote references? Answer: Yes. Both are fully configurable and can be turned on or off. Read more about configuring remote and relative references. Q: How do you handle complex extension types? Answer: We built a function called UnpackExtensions() to handle it. https://pb33f.io/libopenapi/what-changed/ Sun, 29 Jan 2023 08:36:26 -0500 https://pb33f.io/libopenapi/what-changed/ OpenAPI change detection is a feature of libopenapi that allows you to detect changes between two OpenAPI models. It’s the core engine that powers our openapi-changes tool. What is a change? A change in libopenapi is defined as… A property or object state was changed in one of the following ways: Modified Added Removed A change has a binary breaking state as well. It can either be a non-breaking or a breaking change. https://pb33f.io/libopenapi/circular-references/v0_12/ Sun, 29 Jan 2023 07:22:00 -0500 https://pb33f.io/libopenapi/circular-references/v0_12/ [Version 0.12 and below only] Since v0.13 the index and resolver architecture has changed significantly, these documents are for v0.12 and below. View the latest documentation for circular references Circular references are loops in a data structure or Schema that causes loops. components: schemas: One: properties: thing: "$ref": "#/components/schemas/Two" required: - thing Two: description: "test two" properties: testThing: "$ref": "#/components/schemas/One" This creates a circular reference. One depends Two which depends on One One –> Two –> One –>… and so on. https://pb33f.io/libopenapi/resolver/v0_12/ Sun, 29 Jan 2023 05:10:13 -0500 https://pb33f.io/libopenapi/resolver/v0_12/ [Version 0.12 and below only] Since v0.13 the index and resolver architecture has changed significantly, these documents are for v0.12 and below. View the latest documentation for the resolver If you have ever used OpenAPI with golang, you’re probably aware of using $ref to reference other objects like Schemas or Parameters that we want to re-use across a specification, or across multiple specifications. liboenapi knows how to look up these references and resolve them. https://pb33f.io/libopenapi/the-index/v0_12/ Sat, 28 Jan 2023 09:14:36 -0500 https://pb33f.io/libopenapi/the-index/v0_12/ [Version 0.12 and below only] Since v0.13 the index and resolver architecture has changed significantly, these documents are for v0.12 and below. View the latest documentation for the index When creating a model using libopenapi, under the hood, it creates an index of everything that was located in an OpenAPI specification. There is a considerable amount items it tracks: If you’re interested in the full list of items that are tracked, look at the index docs and all of the GetXxx methods are laid out with docs (there’s no point duplicating it here) https://pb33f.io/libopenapi/bundling/ Sat, 28 Jan 2023 07:59:17 -0500 https://pb33f.io/libopenapi/bundling/ Lots of OpenAPI specifications are exploded out across lots of different files. This is great for maintainability, but not so great for portability. Lots of OpenAPI tools do not support exploded / multi-file OpenAPI specifications. Loading and locating references can be tricky, particularly when they are spread across local or remote file systems, so lots of tools just give up on trying to locate references and just ask for a single monolithic file. https://pb33f.io/libopenapi/extensions/ Sat, 28 Jan 2023 07:59:17 -0500 https://pb33f.io/libopenapi/extensions/ OpenAPI extensions (also known as vendor extensions) are properties with a prefix of x- that can be added to many OpenAPI objects throughout the OpenAPI specification. Both high-level and low-level models support extensions and are available on both via the Extensions property available on all models that support it. Extensions can be anything! This means there could be a scalar value like a string, or it could be a highly complex, deeply nested object. https://pb33f.io/libopenapi/model/ Thu, 26 Jan 2023 06:20:33 -0500 https://pb33f.io/libopenapi/model/ Before getting into the code, let’s understand the key differences between OpenAPI versions 3.0 and 3.1. Almost JSON Schema OpenAPI 3.0 is loosely based on top of JSON Schema. In the sense that the Schema used by pretty much everything in OpenAPI, is similar to JSON Schema, but isn’t actually valid. It’s very close, but it’s not actually valid JSON Schema. There are a number of variations and mis-matches Don’t get us wrong, it’s way better than Swagger. https://pb33f.io/libopenapi/openapi/ Thu, 26 Jan 2023 06:20:33 -0500 https://pb33f.io/libopenapi/openapi/ Loading a model from a specification There are two steps to creating a model, creating a document and then building a model from that document. Creating a new document First we need to create a reference to a Document that we create using NewDocument() and pass in a []byte slice that contains the specification. For example: // load an OpenAPI 3 specification from bytes petstore, _ := ioutil.ReadFile("test_specs/petstorev3.json") // create a new document from specification bytes document, err := libopenapi. https://pb33f.io/libopenapi/swagger/ Thu, 26 Jan 2023 06:19:25 -0500 https://pb33f.io/libopenapi/swagger/ If you’re using the v2 model package in libopenapi, please note that it is no longer maintained and will be removed in a future version. DO NOT take a dependency on it. Before we jump into the code, let’s get some context around Swagger with a very short history lesson. The API wars Swagger (Or now known affectionately as OpenAPI 2) first came onto the scene in 2012, which in tech years would make Swagger look like something built in the early 1900s. https://pb33f.io/libopenapi/about/ Sun, 22 Jan 2023 10:38:08 -0500 https://pb33f.io/libopenapi/about/ If you’re looking for an OpenAPI library for golang, you’ve probably already discovered the excellent kin-openapi (which is great by the way). Except, there is one problem with it, that means we can’t use it for our use-cases. kin-openapi is lossy. When parsing OpenAPI specifications at a low level, kin-openapi runs out of power when you need to know the original line numbers and columns and the original node data exposed. https://pb33f.io/openapi-changes/about/ Sun, 22 Jan 2023 10:38:08 -0500 https://pb33f.io/openapi-changes/about/ openapi-changes grew out of earlier internal tooling we built to explain what changed between API revisions. That first generation was useful, but it was incomplete and too inaccurate to trust. So we rebuilt the idea from scratch. Why it exists Most tools in this space do one of two things well: detect compatibility breakage show raw document diffs openapi-changes combines those concerns. It builds a semantic model of the change set, then renders that same model into multiple different views: terminal summaries, an interactive console, machine-readable JSON, markdown reports, and a self-contained HTML report. https://pb33f.io/libopenapi/installing/ Sun, 22 Jan 2023 10:38:08 -0500 https://pb33f.io/libopenapi/installing/ Grab the latest release of libopenapi. go get github.com/pb33f/libopenapi Load an OpenAPI spec into a model import ( "fmt" "github.com/pb33f/libopenapi" "os" ) func readSpec() { // load an OpenAPI 3 specification from bytes petstore, _ := os.ReadFile("test_specs/petstorev3.json") // create a new document from specification bytes document, err := libopenapi.NewDocument(petstore) // if anything went wrong, an error is thrown if err != nil { panic(fmt.Sprintf("cannot create new document: %e", err)) } // because we know this is a v3 spec, we can build a ready to go model from it. https://pb33f.io/openapi-changes/installing/ Sat, 21 Jan 2023 16:29:04 -0500 https://pb33f.io/openapi-changes/installing/ Installing with Homebrew The quickest way to install openapi-changes on macOS or Linux is Homebrew: brew install pb33f/taps/openapi-changes Installing with npm or yarn If you prefer JavaScript package tooling, install it globally with your preferred package manager: yarn global add @pb33f/openapi-changes npm i -g @pb33f/openapi-changes Installing with cURL For CI workflows or environments without a package manager, use the installer script: curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh Running with Docker If you do not want to install anything locally, pull the Docker image: https://pb33f.io/newsletters/example/ Mon, 01 Jan 0001 00:00:00 +0000 https://pb33f.io/newsletters/example/ Header Welcome to the pb33f family! We’re excited to have you on board. A smaller header and things you are a moron and more things. and here is a things and stuff and stufff and junk and other things go in here, lists and boxes and all kinds. I want to make sure that this looks great! we must ensure greatness. and the smallest! boo! NEW! Here’s our latest feature NEW!