You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/api-def/asyncapi-pages/overview.mdx
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
---
2
2
title: What is an AsyncAPI Specification?
3
-
subtitle: AsyncAPI is a standard for documenting event-driven APIs
3
+
description: AsyncAPI is a standard for documenting event-driven APIs
4
4
---
5
5
6
+
<Note>
7
+
Fern only supports AsyncAPI SDK generation for TypeScript and Python.
8
+
</Note>
9
+
6
10
The AsyncAPI Specification is a framework used by developers to document event-driven APIs. The specification
7
11
is written in JSON or YAML and contains all of your channels, messages, schemas, and authentication schemes.
8
12
Fern is compatible with AsyncAPI specification [v2.6.0](https://www.asyncapi.com/docs/reference/specification/v2.6.0) and [v3.0.0](https://www.asyncapi.com/docs/reference/specification/v3.0.0).
9
13
10
-
<Info> Considering options to generate an AsyncAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
11
-
12
14
Below is an example of an AsyncAPI file:
13
15
14
16
```yaml asyncapi.yml
@@ -107,7 +109,9 @@ components:
107
109
- message
108
110
```
109
111
110
-
## Setup your fern folder
112
+
## Set up your fern folder
113
+
114
+
<Info> Considering options to generate an AsyncAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
111
115
112
116
Start by initializing your fern folder with an AsyncAPI spec
Copy file name to clipboardExpand all lines: fern/products/api-def/grpc-pages/overview.mdx
+8-45Lines changed: 8 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,15 @@
1
1
---
2
2
title: What is gRPC?
3
-
subtitle: gRPC is a high-performance RPC framework that uses Protocol Buffers
3
+
description: gRPC is a high-performance RPC framework that uses Protocol Buffers
4
4
---
5
5
6
+
<Note>
7
+
Fern only supports gRPC SDK generation for .NET/C#.
8
+
</Note>
9
+
6
10
gRPC is a modern, open-source, high-performance Remote Procedure Call (RPC) framework that can run in any environment. It uses Protocol Buffers (protobuf) as the interface definition language and supports multiple programming languages.
7
11
Fern is compatible with gRPC services and can generate SDKs and documentation from your `.proto` files.
8
12
9
-
<Info> Need help getting started with gRPC and Fern? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
10
-
11
13
Below is an example of a gRPC service definition:
12
14
13
15
```protobuf user_service.proto
@@ -155,27 +157,10 @@ enum ChatMessageType {
155
157
}
156
158
```
157
159
158
-
## gRPC Features
159
-
160
-
gRPC offers several key features that make it ideal for modern applications:
160
+
## Set up your fern folder
161
161
162
-
### High Performance
163
-
- Binary protocol with Protocol Buffers
164
-
- HTTP/2 transport for multiplexing and flow control
165
-
- Efficient serialization and deserialization
166
-
167
-
### Multiple Communication Patterns
168
-
-**Unary RPCs**: Simple request/response
169
-
-**Server Streaming**: Server sends stream of responses
170
-
-**Client Streaming**: Client sends stream of requests
171
-
-**Bidirectional Streaming**: Both sides send streams
172
-
173
-
### Cross-Platform Support
174
-
- Native support for 10+ programming languages
175
-
- Generated client libraries and server stubs
176
-
- Consistent API across all platforms
162
+
<Info> Need help getting started with gRPC and Fern? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
177
163
178
-
## Setup your fern folder
179
164
180
165
Start by initializing your fern folder with a gRPC service
Copy file name to clipboardExpand all lines: fern/products/api-def/openapi-pages/overview.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,12 @@
1
1
---
2
2
title: What is an OpenAPI Specification?
3
-
subtitle: OpenAPI is a standard for documenting REST APIs
3
+
description: OpenAPI is a standard for documenting REST APIs
4
4
---
5
5
6
6
The OpenAPI Specification (OAS) is a framework used by developers to document REST APIs. The specification
7
7
written in JSON or YAML and contains all of your endpoints, parameters, schemas, and authentication schemes.
8
8
Fern is compatible with the latest OAS release, which is currently [v3.1.1](https://spec.openapis.org/#openapi-specification).
9
9
10
-
<Info> Considering options to generate an OpenAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
11
-
12
10
Below is an example of an OpenAPI file:
13
11
14
12
```yaml openapi.yml
@@ -106,6 +104,8 @@ components:
106
104
107
105
## Setup your fern folder
108
106
107
+
<Info> Considering options to generate an OpenAPI spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
108
+
109
109
Start by initializing your fern folder with an OpenAPI spec
Copy file name to clipboardExpand all lines: fern/products/api-def/openrpc-pages/overview.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,12 @@
1
1
---
2
2
title: What is an OpenRPC Specification?
3
-
subtitle: OpenRPC is a standard for documenting JSON-RPC APIs
3
+
description: OpenRPC is a standard for documenting JSON-RPC APIs
4
4
---
5
5
6
6
The OpenRPC Specification is a framework used by developers to document JSON-RPC APIs. The specification
7
7
is written in JSON or YAML and contains all of your methods, parameters, schemas, and server configurations.
8
8
Fern is compatible with OpenRPC specification [v1.3.2](https://spec.open-rpc.org/) and [v1.2.6](https://github.com/open-rpc/spec/releases/tag/1.2.6).
9
9
10
-
<Info> Considering options to generate an OpenRPC spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
11
-
12
10
Below is an example of an OpenRPC file:
13
11
14
12
```yaml openrpc.yml
@@ -144,7 +142,9 @@ components:
144
142
- timestamp
145
143
```
146
144
147
-
## Setup your fern folder
145
+
## Set up your fern folder
146
+
147
+
<Info> Considering options to generate an OpenRPC spec? Get live support [here](https://fern-community.slack.com/join/shared_invite/zt-2dpftfmif-MuAegl8AfP_PK8s2tx350Q%EF%BB%BF#/shared-invite/email) </Info>
148
148
149
149
Start by initializing your fern folder with an OpenRPC spec
0 commit comments