test
Docs
Examples
GitHub
Support
Introduction
Quick Start
Creating your first API
Running the API
Connecting to the API
Server guide (Carbond)
Application structure
Defining your Node.js package
Defining your Service
Using __, _o, and o
Running your Service
Services
Services and Endpoints
Service middleware
Running Services from the command line
Embedding Services into larger applications
(advanced use)
Endpoints
Simple Endpoints
Endpoints with named path parameters
Sub-endpoints
Accessing Service properties from within Endpoints
Operations
Defining Operations
Operation parameters
Parameter schemas
Parameter parsing
Operation responses
Database management
Collections
Operation handlers
Operation configuration
Operation REST interface
Operation pre/post hooks
MongoDBCollection class
MongoDBCollection operation configuration
Authentication and access control
Authentication
Access Control
Error handling
Logging
Logging messages
Controling verbosity
Logging output
Testing
Service Tests
Carbon Core
Atom
Bond
Fibers
Leafnode
Test-Tube
Module Reference
atom
bond
carbond.collections.Collection
carbond.collections.CollectionOperationConfig
carbond.collections.FindConfig
carbond.collections.FindObjectConfig
carbond.collections.IdGenerator
carbond.collections.InsertConfig
carbond.collections.InsertObjectConfig
carbond.collections.RemoveConfig
carbond.collections.RemoveObjectConfig
carbond.collections.SaveConfig
carbond.collections.SaveObjectConfig
carbond.collections.UpdateConfig
carbond.collections.UpdateObjectConfig
carbond.docgen.APIBPGenerator
carbond.Endpoint
carbond.IdGenerator
carbond.mongodb.MongoDBCollection
carbond.mongodb.MongoDBFindConfig
carbond.mongodb.MongoDBFindObjectConfig
carbond.mongodb.MongoDBInsertConfig
carbond.mongodb.MongoDBInsertObjectConfig
carbond.mongodb.MongoDBRemoveConfig
carbond.mongodb.MongoDBRemoveObjectConfig
carbond.mongodb.MongoDBSaveConfig
carbond.mongodb.MongoDBSaveObjectConfig
carbond.mongodb.MongoDBUpdateConfig
carbond.mongodb.MongoDBUpdateObjectConfig
carbond.ObjectIdGenerator
carbond.Operation
carbond.OperationParameter
carbond.OperationResponse
carbond.ParameterParser
carbond.Request
carbond.Response
carbond.security.Acl
carbond.security.ApiKeyAuthenticator
carbond.security.Authenticator
carbond.security.BcryptHasher
carbond.security.CollectionAcl
carbond.security.EndpointAcl
carbond.security.Hasher
carbond.security.HttpBasicAuthenticator
carbond.security.MongoDBApiKeyAuthenticator
carbond.security.MongoDBHttpBasicAuthenticator
carbond.security.NoopHasher
carbond.security.ObjectAcl
carbond.security.Sha256Hasher
carbond.Service
carbond.SslOptions
carbond.SwaggerDescriptorGenerator
carbond.test.ServiceTest
carbond.UUIDGenerator
leafnode.Collection
leafnode.Cursor
leafnode.DB
test-tube.HttpTest
test-tube.HttpTestHistory
test-tube.Test
test-tube.TestContext
Examples
Support
Reporting issues
Carbon
Docs
/
Server guide (Carbond)
/
Authentication and access control
Authentication and access control
ΒΆ
Authentication
Built-in authenticators
Custom Authenticators
Examples
Access Control
ACLs
Endpoint ACLs
Collection ACLs
Re-using ACLs across multiple Endpoints