Skip to content

Commit 93b210e

Browse files
authored
clarification and example on ApiID and VersionID
1 parent 51c23f6 commit 93b210e

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,14 @@ const app = express();
3737

3838
// Configure the global speakeasy SDK instance
3939
const cfg: Config = {
40-
apiKey: "YOUR API KEY HERE", // retrieve from Speakeasy API dashboard.
41-
apiID: "YOUR API ID HERE", // custom Api ID to associate captured requests with.
42-
versionID: "YOUR VERSION ID HERE", // custom Version ID to associate captured requests
43-
port: 3000, // The port number your express app is listening on (required to build full URLs on non-standard ports)
40+
apiKey: "YOUR API KEY HERE", // retrieve from Speakeasy API dashboard.
41+
apiID: "YOUR API ID HERE", // enter a name that you'd like to associate captured requests with.
42+
// This name will show up in the Speakeasy dashboard. e.g. "PetStore" might be a good ApiID for a Pet Store's API.
43+
// No spaces allowed.
44+
versionID: "YOUR VERSION ID HERE", // enter a version that you would like to associate captured requests with.
45+
// The combination of ApiID (name) and VersionID will uniquely identify your requests in the Speakeasy Dashboard.
46+
// e.g. "v1.0.0". You can have multiple versions for the same ApiID (if running multiple versions of your API)
47+
port: 3000, // The port number your express app is listening on (required to build full URLs on non-standard ports)
4448
};
4549
speakeasy.configure(cfg);
4650

@@ -70,10 +74,14 @@ export class AppModule implements NestModule {
7074
configure(consumer: MiddlewareConsumer) {
7175
// Configure the global speakeasy SDK instance
7276
const cfg: Config = {
73-
apiKey: "YOUR API KEY HERE", // retrieve from Speakeasy API dashboard.
74-
apiID: "YOUR API ID HERE", // custom Api ID to associate captured requests with.
75-
versionID: "YOUR VERSION ID HERE", // custom Version ID to associate captured requests
76-
port: 3000, // The port number your express app is listening on (required to build full URLs on non-standard ports)
77+
apiKey: "YOUR API KEY HERE", // retrieve from Speakeasy API dashboard.
78+
apiID: "YOUR API ID HERE", // enter a name that you'd like to associate captured requests with.
79+
// This name will show up in the Speakeasy dashboard. e.g. "PetStore" might be a good ApiID for a Pet Store's API.
80+
// No spaces allowed.
81+
versionID: "YOUR VERSION ID HERE", // enter a version that you would like to associate captured requests with.
82+
// The combination of ApiID (name) and VersionID will uniquely identify your requests in the Speakeasy Dashboard.
83+
// e.g. "v1.0.0". You can have multiple versions for the same ApiID (if running multiple versions of your API)
84+
port: 3000, // The port number your express app is listening on (required to build full URLs on non-standard ports)
7785
};
7886
speakeasy.configure(cfg);
7987

@@ -382,4 +390,4 @@ app.all("/", (req, res) => {
382390

383391
// the rest of your handlers code
384392
});
385-
```
393+
```

0 commit comments

Comments
 (0)