Guides¶
The APIs tab tells what each API does. These guides tell how the pieces around them work, in the order you meet them.
{ }Schema and dataThe schema of a table, auto increments, optimistic concurrency control, multi-tenant databases and migration scripts.
g.Your codeThe global object g, process initializers, test cases, developer tools, Git, developer accounts, code search and browsers with Playwright or Puppeteer.
⛨Security and accessSecrets, groups, API users, role based permissions, the security report, single sign-on and every auth provider.
⚙SettingsCaching, access type and auth providers per database, table and API ; sandbox settings ; the configuration of API Maker.
↗Performance and operationsCaching, Index Maker and automatic indexes, logs, dashboards, internationalization, deploying a new version of API Maker.
⛁Connection stringsThe connection string of MongoDB, MySQL, MariaDB, PostgreSQL, Oracle and SQL Server, with SSL and cloud examples.
▦UI MakerGrids and forms generated from your tables, configured in JSON. Kept for the projects which use it.deprecated
Read in this order¶
- Table schema : how a table is described and what the schema APIs do with it.
- Global object g : the one object your code gets.
- Secrets, then API group permission and Handle role based permissions : who may do what.
- Settings : caching, access type and auth providers at every level.
- Automatic caching, Index Maker, Log profile and the dashboards : running it.
- Git integration and Deploy API Maker : shipping it.