User manual · iPhone, iPad, and Android phones and tablets

Baton for iPhone and Android

Baton on a phone, screen by screen: sending a request and reading what came back, variables and secrets, auth and scripts, GraphQL and WebSocket, bringing collections in from other clients, and git sync — with an annotated screenshot of each screen, at a phone’s size.

1. Chapter 1About BatonWhat Baton is on iPhone and Android: an API client whose requests are plain YAML files in a git repository you own.
2. Chapter 2The screenFind your way around Baton on a phone: the request and its response, the drawer, search, and the status rows.
3. Chapter 3WorkspacesCreate and switch Baton workspaces on a phone, where each one lives inside the app until git sync takes it elsewhere.
4. Chapter 4Collections and requestsCreate collections on a phone, import from Postman, OpenAPI, Bruno, Insomnia, Yaak or curl, follow a spec, and export.
5. Chapter 5Sending a requestSend a request from Baton on a phone and read what came back: the response, what was sent, the console, history and examples.
6. Chapter 6Variables and environmentsUse {{variables}} in Baton on a phone, switch environments from the drawer, and mark one as production.
7. Chapter 7SecretsHow Baton keeps secret values out of your repository on a phone: names in the file, values in the Keychain, Keystore or Vault.
8. Chapter 8AuthorizationBearer, basic, API key, AWS Signature, digest and OAuth 2.0 in Baton on a phone — set once on a collection, inherited.
9. Chapter 9Request bodiesJSON, text, form, multipart, binary and GraphQL request bodies in Baton on a phone, and how each is sent.
10. Chapter 10Scripts and testsPre-request and test scripts in JavaScript on a phone, with the same baton.* API and sandbox as everywhere else.
11. Chapter 11GraphQL and WebSocketGraphQL on a phone with schema introspection and a query builder, and WebSocket sessions with a live message log.
12. Chapter 12Running a collectionRun every request in a collection from a phone, in order, and read the results request by request and test by test.
13. Chapter 13Git sync and the workerCommit and pull from a phone through GitHub, GitLab or Bitbucket, and pair the worker that runs your schedules.
14. Chapter 14Settings and troubleBaton's settings on a phone, why the store apps need no license key, and what the common error messages mean.
15. Chapter 15The iPhone and Android appsWhat the Baton apps from the App Store and Google Play do differently: storage, sync, secrets, links and agents.