Model-Driven API Generation
Model-Driven API generation is performed via the Tools > Forward-Engineering > API Model menu option.
You can find all details here.
Documentation
Table of contents
- Welcome to Hackolade Studio
- Getting started
- Tutorial
- What is a data model?
- Overview of JSON and JSON Schema
- Query-driven data modeling based on access patterns
- Create your first data model
- Add nested objects and arrays
- Add a choice, conditional, or pattern field
- Add relationships
- Import or reverse-engineer
- Export or forward-engineer
- Generate documentation and pictures
- Use graph diagrams
- Create a REST API model
- Leverage a Polyglot data model
- How-to guides
- NoSQL databases, storage formats, REST APIs
- Polyglot Data Model
- JSON Schema
- Couchbase
- DynamoDB
- MongoDB
- Download additional target plugins
- Avro schema
- BigQuery
- Cassandra
- Confluent Schema Registry
- Cosmos DB SQL & MongoDB APIs
- Cosmos DB Gremlin
- Delta Lake on Databricks
- DocumentDB
- Elasticsearch
- EventBridge
- Event Hubs Azure Schema Registry
- Firebase
- Firestore
- Glue Data Catalog
- HBase
- Hive
- JanusGraph
- MariaDB
- MarkLogic
- MySQL
- Neo4j
- Neptune Gremlin
- OpenAPI
- Oracle
- Parquet schema
- PostgreSQL
- Protobuf
- Pulsar Schema Registry
- Redshift
- ScyllaDB
- Snowflake
- SQL Server
- Swagger API
- Synapse
- TinkerPop
- YugabyteDB
- Concepts
- Overview of user interface
- Welcome page
- Workspace
- JSON Schema Editor
- Manipulating shapes
- Show model diff
- Compare and merge models
- Delta model and ALTER script
- Generate documentation
- Print a diagram
- Shortcut keys
- Re-usable objects definitions
- User-defined custom properties
- Command Line Interface
- Naming conventions
- Lineage capture
- Collibra Data Dictionary integration
- MongoDB Field-Level Encryption
- Repository
- Concepts
- Pre-requisites
- Authentication
- Clone a remote repository
- Open a local repository
- Explore repository
- Checkout a branch
- Commit local changes
- Pull remote commits
- Push local commits
- Solve conflicts
- Connect to a repository hub
- Submit for review
- Review change requests
- Branch protection
- Git subtree
- Other actions
- Jira integration
- Questions & Answers
- Quick start guide
- Create a new model from scratch
- Forward-Engineering
- JSON Document
- YAML file
- JSON Schema
- YAML Schema
- Excel file
- API Model
- Target-specific
- Avro schema
- BigQuery DDL
- Cassandra CQL
- Cosmos DB SQL API scripts
- Cosmos DB Gremlin script
- Couchbase scripts
- Delta Lake scripts
- DocumentDB script
- DynamoDB scripts
- Elasticsearch mappings
- EventBridge
- Ottoman Schema
- Firebase (TBA)
- Firestore (TBA)
- Glue Data Catalog
- HBase
- Hive HQL
- JanusGraph Gremlin
- MariaDB DDL
- MarkLogic
- MongoDB scripts
- Mongoose Schema
- MySQL DDL
- Neo4j Cypher
- Neptune with Gremlin API
- OpenAPI file
- Oracle DDL
- Parquet schema
- PostgreSQL DDL
- Protobuf schema
- Redshift DDL
- ScyllaDB CQL
- Snowflake DDL
- SQL Server DDL
- Synapse DDL
- Swagger file
- TinkerPop Gremlin
- Forward-Engineering
- Reverse-engineering
- JSON document
- YAML file
- JSON Schema
- YAML Schema
- SQL DDL
- XSD (XML Schema Definition)
- Excel template
- Target-specific
- Avro file or schema
- Connect to a BigQuery instance
- Connect to a Cassandra instance
- Connect to Confluent Schema Registry
- Connect to a Cosmos DB instance
- Connect to a Couchbase instance
- Connect to a Delta Lake instance
- Connect to a DocumentDB instance
- Connect to a DynamoDB instance
- Connect to an Elasticsearch instance
- Connect to EventBridge Schema Registry
- Connect to a Firebase instance (TBA)
- Connect to a Firestore instance (TBA)
- Connect to an AWS Glue Data Catalog
- Connect to an HBase instance
- Connect to a Hive instance
- Connect to a JanusGraph instance
- Connect to a MariaDB instance
- Connect to a MarkLogic instance
- Connect to a MongoDB instance
- Connect to a MySQL instance
- Connect to a Neo4j instance
- Connect to a Neptune instance
- OpenAPI file
- Connect to an Oracle instance
- Parquet schema
- Connect to a PostgreSQL instance
- Protobuf schema file or registry
- Connect to Amazon Redshift
- Connect to a ScyllaDB instance
- Connect to a Snowflake instance
- Connect to a SQL Server instance
- Connect to Synapse
- Swagger file
- Connect to a TinkerPop instance
- Connect to YugabyteDB
- Suggest denormalization of a SQL schema
- Infer Primary Keys and Foreign Key Relationships
- Model-Driven API Generation
- Generate mock data for testing
- Create a new model from scratch
- Change log
- FAQ and troubleshooting
- Glossary
On this page