OpenAPI specification

MFI Suite publishes versioned OpenAPI specs so integration partners can auto-generate clients, validate requests, and import endpoints into Postman or Insomnia.

Fetching the spec

# Public access (no auth required for spec)
curl https://microfinance.mybridgeerp.com/api/openapi.json > openapi.json

# Or open interactive UI in browser
open https://microfinance.mybridgeerp.com/api/docs

Spec structure

• info — title, version, contact, license
• servers — base URLs (production, staging)
• tags — endpoint grouping (Members, Loans, Savings, etc.)
• paths — all endpoints with parameters, request/response schemas
• components.schemas — reusable data types (Member, Loan, etc.)
• components.securitySchemes — OAuth2, ApiKey
• components.responses — standard 4xx/5xx error envelopes

Generating clients

Use the official openapi-generator for unsupported languages, or one of our SDKs (Python, Node, Java, Go).

# Generate a TypeScript axios client
npx openapi-typescript-codegen --input openapi.json \
  --output ./mfi-client \
  --client axios

# Generate a Java client
openapi-generator-cli generate -i openapi.json \
  -g java -o ./mfi-java-client \
  --additional-properties=library=resttemplate,artifactId=mfi-client

# Generate a Python client
openapi-generator-cli generate -i openapi.json \
  -g python -o ./mfi-py-client

Schema validation

Use the spec to validate requests and responses in CI tests, preventing breakage when MFI Suite is upgraded.

from openapi_core import Spec, V31RequestValidator, V31ResponseValidator
import requests, json

spec = Spec.from_file('openapi.json')

# Validate request
req = ...  # construct request object
V31RequestValidator(spec).validate(req)

# Validate response
resp = requests.get('https://microfinance.mybridgeerp.com/api/v1/loans/9183', ...)
V31ResponseValidator(spec).validate(req, resp)

Importing to Postman / Insomnia

1. Open Postman, File > Import
2. Choose Link, paste https://microfinance.mybridgeerp.com/api/openapi.json
3. Import as Collection
4. Set environment variable {{token}} via the OAuth helper
5. Run any endpoint; the schema panel auto-validates request body

Worked scenarios

Reference

Top-level schemas

Troubleshooting

See also

• Api
• Rest
• Sdks