Skip to content

Commit 11bf938

Browse files
committed
Sync open source content 🐝 (from 1a077c4828798c6b088b083c74cdaa1a77b194c1)
1 parent 7d01a65 commit 11bf938

21 files changed

Lines changed: 32 additions & 32 deletions

File tree

β€Žapi-design/developer-experience.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,4 +189,4 @@ By following these principles, an API will be something that developers actually
189189

190190
### Further reading
191191

192-
To learn more about API design, [check out our guide to API design best practices](/post/api-design).
192+
To learn more about API design, [check out our guide to API design best practices](/blog/api-design).

β€Žapi-design/testing.mdxβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ It's not exactly a pyramid, but you get the idea.
3535

3636
At the base, we have **unit tests**. These are the tests that verify the internal workings of your API. They're important for maintaining code quality and catching regressions, but they don't tell us much about how the API behaves from a consumer's perspective, so we'll limit their scope and keep them private.
3737

38-
In the middle, we've added **contract tests**. These tests verify that the API's contract with consumers is upheld. They're a step up from unit tests because they verify the API's behavior at its boundaries. We've covered contract testing in detail in a [previous post](https://www.speakeasy.com/post/contract-testing-with-openapi).
38+
In the middle, we've added **contract tests**. These tests verify that the API's contract with consumers is upheld. They're a step up from unit tests because they verify the API's behavior at its boundaries. We've covered contract testing in detail in a [previous post](/blog/contract-testing-with-openapi).
3939

4040
We'll focus on **integration tests** at the top-middle layer of the pyramid. These tests verify the API's behavior from a consumer's perspective. They're the most relevant tests for API consumers because they show exactly how the API behaves in different scenarios.
4141

@@ -415,7 +415,7 @@ While sharing your API's behavioral tests provides tremendous value, there are s
415415

416416
### Contract testing
417417

418-
Investigate tools like [Pact](/post/pact-vs-openapi) that formalize the provider-consumer contract. These approaches complement public tests by allowing consumers to define their expectations explicitly.
418+
Investigate tools like [Pact](/blog/pact-vs-openapi) that formalize the provider-consumer contract. These approaches complement public tests by allowing consumers to define their expectations explicitly.
419419

420420
### Chaos testing
421421

β€Ždocs/sdks/create-client-sdks.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Saved changes in the Studio automatically triggers a regeneration of the SDK loc
158158
}}
159159
/>
160160

161-
It is also possible to make changes without the Studio. Check out the following guide on [customizing SDKs](/docs/customize-sdks/) for all the details.
161+
It is also possible to make changes without the Studio. Check out the following guide on [customizing SDKs](/docs/sdks/customize/basics) for all the details.
162162

163163
## Next Step: Uploading the SDK to GitHub
164164

β€Ždocs/sdks/customize/typescript/configuring-module-format.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,4 @@ For most projects, `esm` is the best choice. Most modern tooling supports ESM, a
102102
## Additional reading
103103

104104
- [TypeScript configuration options](/docs/gen-reference/ts-config)
105-
- [Lean SDKs with standalone functions](/post/standalone-functions)
105+
- [Lean SDKs with standalone functions](/blog/standalone-functions)

β€Ždocs/sdks/customize/typescript/disabling-barrel-files.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ Whether you should use `useIndexModules` depends on your project's priorities:
110110
Visit the following pages to learn more about generating SDKs with Speakeasy:
111111

112112
- [TypeScript configuration options](/docs/customize/typescript/configuring-module-format)
113-
- [Lean SDKs with standalone functions](/post/standalone-functions)
113+
- [Lean SDKs with standalone functions](/blog/standalone-functions)

β€Ždocs/sdks/languages/golang/oss-comparison-go.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ To start our comparison, we installed all four generators on a local machine run
141141

142142
### Installing the OpenAPI Generator CLI
143143

144-
OpenAPI Generator depends on Java, [which we covered at length previously](/post/speakeasy-oss-python-generator#our-experience-installing-the-openapi-generator-cli). We concluded that managing the OpenAPI Generator Java dependencies manually just wasn't worth the effort.
144+
OpenAPI Generator depends on Java, [which we covered at length previously](/docs/sdks/languages/python/oss-comparison-python#preparing-the-sdk-generators). We concluded that managing the OpenAPI Generator Java dependencies manually just wasn't worth the effort.
145145

146146
Installing `openapi-generator` using Homebrew installs `openjdk@11` and its many dependencies:
147147

β€Ždocs/sdks/languages/java/oss-comparison-java.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Below is a table that summarizes the key differences between the two SDKs:
3636
]}
3737
/>
3838

39-
Read more about these headline features of Speakeasy-created Java SDKs in the [March 2024 release notes](/post/release-java-ga), or consult the [Speakeasy Java SDK documentation](/docs/languages/java/methodology-java).
39+
Read more about these headline features of Speakeasy-created Java SDKs in the [March 2024 release notes](/blog/release-java-ga), or consult the [Speakeasy Java SDK documentation](/docs/languages/java/methodology-java).
4040

4141
For a detailed technical comparison, read on!
4242

β€Ždocs/sdks/languages/php/oss-comparison-php.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { Table } from "@/mdx/components";
66

77
Many of our users have switched from [OpenAPI Generator](https://openapi-generator.tech/) to Speakeasy for their PHP SDKs. Learn how to use both SDK creators in this guide, and the differences between them.
88

9-
Open-source OpenAPI generators are great for experimentation but lack the reliability, performance, and intuitive developer experience required for critical applications. As an alternative, Speakeasy creates [idiomatic SDKs](/post/client-sdks-as-a-service) that meet the bar for enterprise use.
9+
Open-source OpenAPI generators are great for experimentation but lack the reliability, performance, and intuitive developer experience required for critical applications. As an alternative, Speakeasy creates [idiomatic SDKs](/blog/speakeasy-vs-openapi-generator) that meet the bar for enterprise use.
1010

1111
Here's the high-level summary of the differences between Speakeasy and OpenAPI Generator:
1212

β€Ždocs/sdks/languages/python/methodology-python.mdxβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { FileTree } from "nextra/components";
88

99
<Callout title="OSS Comparison" type="info">
1010
For a comparison between the Speakeasy Python SDK and some popular open-source
11-
generators, see [**this page**](/post/speakeasy-oss-python-generator).
11+
generators, see [**this page**](/docs/sdks/languages/python/oss-comparison-python).
1212
</Callout>
1313

1414
## SDK Overview

β€Ždocs/sdks/languages/python/oss-comparison-python.mdxβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import { Callout, Table } from "@/mdx/components";
99

1010
Many of our users have switched from [OpenAPI Generator](https://openapi-generator.tech/) to Speakeasy for their Python SDKs. Learn how to use both SDK creators in this guide, and the differences between them.
1111

12-
Open-source OpenAPI generators are great for experimentation but lack the reliability, performance, and intuitive developer experience required for critical applications. As an alternative, Speakeasy creates [idiomatic SDKs](/post/client-sdks-as-a-service) that meet the bar for enterprise use.
12+
Open-source OpenAPI generators are great for experimentation but lack the reliability, performance, and intuitive developer experience required for critical applications. As an alternative, Speakeasy creates [idiomatic SDKs](/blog/speakeasy-vs-openapi-generator) that meet the bar for enterprise use.
1313

1414
In this post, we'll focus on Python, but Speakeasy can also create SDKs in Go, TypeScript, Java, Ruby, PHP, and more.
1515

1616
<Callout title="View More Comparisons" type="info">
17-
- [Read about the differences between TypeScript SDKs generated by Speakeasy and OpenAPI Generator.](/post/speakeasy-sdk-vs-openapi-typescript-generator/) <br/>
18-
- [Read about the differences between Go SDKs generated by Speakeasy and OpenAPI Generator.](/post/speakeasy-oss-go-generator)
17+
- [Read about the differences between TypeScript SDKs generated by Speakeasy and OpenAPI Generator.](/docs/sdks/languages/typescript/oss-comparison-ts) <br/>
18+
- [Read about the differences between Go SDKs generated by Speakeasy and OpenAPI Generator.](/docs/sdks/languages/golang/oss-comparison-go)
1919
</Callout>
2020

2121
Here's a summary of the major differences between a Python SDK created using Speakeasy, compared to an SDK created by the OpenAPI Generator. Unless support for Python 3.9 or earlier is critically important, Speakeasy is recommended for Python SDKs.
@@ -507,7 +507,7 @@ The OpenAPI Generator class also has to include many boilerplate methods for Pyd
507507

508508
### Open enums
509509

510-
Speakeasy allows adding the custom attribute `x-speakeasy-unknown-values` to an OpenAPI field to allow [open enums](/post/open-enums).
510+
Speakeasy allows adding the custom attribute `x-speakeasy-unknown-values` to an OpenAPI field to allow [open enums](/blog/open-enums).
511511

512512
```yaml
513513
status:

0 commit comments

Comments
Β (0)