Guides and FAQs

This section will give answers to your most pressing questions about using the godspeed meta-framework. It is designed to be easy to follow and understand, with step-by-step instructions to help illustrate each process.

Setting up the APIs of your service

• How to create Rest APIs in Godspeed framework?

• How to generate CRUD APIs?

• How to open Swagger UI for your APIs?

• How to generate postman collection for your APIs?

• How to add JWT authentication in your Rest APIs?

• How to use OAuth2 for user login and protection of your endpoints?

• How to disable authentication for a particular endpoint?

• How to call REST APIs using Axios?

• How to call APIs using client SDK?

• How to handle API callbacks and webhooks?

Writing your Workflows or Functions

In Godspeed, the words Workflows and Functions mean one and the same thing, i.e. your business logic.

• How to write typescript workflows in godspeed?

• How to write yaml workflows in godspeed?

Accessing other APIs, databases and other datastores from workflows

In Godspeed, datasource can mean any place where you send or retrieve data from. It could mean:

• External APIs

• Datastores

  • Databases (Types - SQL, NoSQL, graph, key value, columnar, OLAP, OLTP, document)
  • Caches
  • Search engine
  • Vector stores (specially useful for AI and recommendation engines)
  • File system or files
  • Memory

• How to access databases using Prisma?

• How to access databases using Mongoose?

• How to access any datastore by creating a custom datasource?

• How to invoke datasource clients from typescript workflows?

• How to invoke datasource clients from yaml workflows?

• How to access the environment variables from the typescript workflows?

• How to update and run the project after renaming any file?

• How to handle secrets, api keys, connection_urls etc.?

• How to export a variable in environment ?