--- title: Naming API Endpoints description: Getting your API documentation right can be a challenge. Here are some tips for naming API endpoints that will enhance your API development process. image: https://blog.dreamfactory.com/hubfs/Imported_Blog_Media/Image73-1024x576.jpg --- [![DreamFactory logo](https://cdn.prod.website-files.com/64ed8da8a866be7a702fbae0/68d51994d3678214b54acb60_dreamfactory-navbar-logo.svg)](https://www.dreamfactory.com/) Products & Services [AI Data Gateway](https://www.dreamfactory.com/ai-data-gateway/overview) [Overview Why DreamFactory exists](https://www.dreamfactory.com/ai-data-gateway/overview) [Data Gov, Comp, Security Policy enforcement at the API layer](https://www.dreamfactory.com/ai-data-gateway/ai-data-governance) [Standard API Layer One contract for every backend](https://www.dreamfactory.com/ai-data-gateway/standard-api-layer) [API Gateway Functionality Routing, auth, rate limits, observability](https://www.dreamfactory.com/ai-data-gateway/api-gateway-functionality) [Deployment & Integration Self-hosted, cloud, hybrid](https://www.dreamfactory.com/ai-data-gateway/on-premise-deployment-and-integration) [Developer Productivity Auto-generated, never hand-coded](https://www.dreamfactory.com/ai-data-gateway/ai-development-accelerated) [AI App Architectures Patterns for RAG, agents, MCP](https://www.dreamfactory.com/ai-data-gateway/enterprise-ai-architectures) AI Data Models [AIOpenAI](https://www.dreamfactory.com/use-cases/openai) [GGoogle Gemini](https://www.dreamfactory.com/use-cases/google-gemini) [CAnthropic Claude](https://www.dreamfactory.com/use-cases/anthropic-claude-landing) [LMeta Llama](https://www.dreamfactory.com/use-cases/meta-llama) [MMistral AI](https://www.dreamfactory.com/use-cases/mistral) [CoCohere](https://www.dreamfactory.com/use-cases/cohere) Services and support [Quickstart Service Packages Expert-led Quickstarts to production](https://www.dreamfactory.com/services-and-support/quickstart-services-packages) API Management [Generate & Manage REST APIs From any database, in seconds](https://www.dreamfactory.com/api-management/generate-rest-apis) [Features Security, scripting, self-hosted & more](https://www.dreamfactory.com/api-management/features) [API Generation The complete guide to auto-generated APIs](https://blog.dreamfactory.com/a-complete-guide-to-api-generation) [API Management Concepts, tools, and best practises](https://blog.dreamfactory.com/what-is-api-management-a-brief-overview-of-api-management-concepts-and-tools?_gl=1*jl0njh*_gcl_au*MjQzMjgwMTc3LjE3ODIzMjI3MzY) Use Cases AI Use Cases [AI Data Access Secure, governed reads for your LLMs](https://www.dreamfactory.com/use-cases/ai-data-access) [MCP Server Drop-in Model Context Protocol](https://www.dreamfactory.com/use-cases/mcp-server) [Legacy Modernization Wrap mainframes with REST](https://www.dreamfactory.com/use-cases/legacy-modernization) [Data Governance Audit every call, enforce every policy](https://www.dreamfactory.com/use-cases/data-governance) [Customer Case Studies](https://www.dreamfactory.com/case-studies) [Energy Modernization](https://www.dreamfactory.com/case-studies/energy-snowflake-modernization) [Government Modernization](https://www.dreamfactory.com/case-studies/government-mainframe-oracle-modernization) [Government Business Intelligence](https://www.dreamfactory.com/case-studies/government-sql-server-bi-analyst-queries) [Manufacturing Modernization](https://www.dreamfactory.com/case-studies/steel-manufacturing-sap-erp-modernization) [Financial Services Investor Portal](https://www.dreamfactory.com/case-studies/financial-services-sql-server-investor-portal) [Non-Profit Partner Data Sharing](https://www.dreamfactory.com/case-studies/non-profit-sql-server-partner-data-sharing) [Professional Services Exec Dashboards](https://www.dreamfactory.com/case-studies/professional-services-erp-dashboards) [Education HR and External Data Sharing](https://www.dreamfactory.com/case-studies/education-student-hr-sql-server-mysql-external-data-sharing) Industries Industries #### [Healthcare HIPAA-grade APIs across EHR, claims, and labs.](https://www.dreamfactory.com/use-cases/healthcare) #### [Financial Services Portfolios, partners, and portals on one layer.](https://www.dreamfactory.com/use-cases/financial-services) #### [Government Modernize mainframes without re-platforming.](https://www.dreamfactory.com/use-cases/government) #### [Manufacturing SAP, MES, and shop-floor data, governed.](https://www.dreamfactory.com/use-cases/manufacturing) #### [Spotlight How enterprises run on DreamFactory From healthcare to energy to finance — governance baked into every endpoint. Browse case studies →](https://www.dreamfactory.com/case-studies) Connectors SQL Database [SQL SQL Server](https://www.dreamfactory.com/connectors/sql-server) [OR Oracle](https://www.dreamfactory.com/connectors/oracle) [PG PostgreSQL](https://www.dreamfactory.com/connectors/postgresql) [My MySQL](https://www.dreamfactory.com/connectors/mysql) NoSQL & Docs [Dy DynamoDB](https://www.dreamfactory.com/connectors/dynamodb) [Do DocumentDB](https://www.dreamfactory.com/connectors/azure-documentdb) [Mo MongoDB](https://www.dreamfactory.com/connectors/mongodb) [Cb CouchDB](https://www.dreamfactory.com/connectors/couch-db) Cloud Warehouses [S3 S3](https://www.dreamfactory.com/connectors/amazon-s3) [Ab Azureblob](https://www.dreamfactory.com/connectors/azure-blob) [FS FTP/SFTP](https://www.dreamfactory.com/connectors/ftp-sftp) [LS Local Storage](https://www.dreamfactory.com/connectors/local-storage) C & SaaS [Sf Salesforce](https://www.dreamfactory.com/connectors/salesforce) [API REST / SOAP](https://www.dreamfactory.com/connectors/soap-to-rest) [See all 30+ connectors](https://www.dreamfactory.com/connectors) [Blog](https://blog.dreamfactory.com/) [FREE 30 Minute Demo](https://www.dreamfactory.com/demo) [![DreamFactory logo](https://cdn.prod.website-files.com/64ed8da8a866be7a702fbae0/68d51994d3678214b54acb60_dreamfactory-navbar-logo.svg)](https://www.dreamfactory.com/) ![hamburger](https://blog.dreamfactory.com/hubfs/raw_assets/public/dreamfactory/images/megamenu/menu-hamburger.svg) ![close](https://blog.dreamfactory.com/hubfs/raw_assets/public/dreamfactory/images/megamenu/close-menu.svg) Back to main menu Products & Services Use Cases Industries Connectors [Blog](https://blog.dreamfactory.com/) [FREE 30 Minute Demo](https://www.dreamfactory.com/demo) [AI Data Gateway](https://www.dreamfactory.com/ai-data-gateway/overview) [Overview Why DreamFactory exists](https://www.dreamfactory.com/ai-data-gateway/overview) [Data Gov, Comp, Security Policy enforcement at the API layer](https://www.dreamfactory.com/ai-data-gateway/ai-data-governance) [Standard API Layer One contract for every backend](https://www.dreamfactory.com/ai-data-gateway/standard-api-layer) [API Gateway Functionality Routing, auth, rate limits, observability](https://www.dreamfactory.com/ai-data-gateway/api-gateway-functionality) [Deployment & Integration Self-hosted, cloud, hybrid](https://www.dreamfactory.com/ai-data-gateway/on-premise-deployment-and-integration) [Developer Productivity Auto-generated, never hand-coded](https://www.dreamfactory.com/ai-data-gateway/ai-development-accelerated) [AI App Architectures Patterns for RAG, agents, MCP](https://www.dreamfactory.com/ai-data-gateway/enterprise-ai-architectures) AI Data Models [AIOpenAI](https://www.dreamfactory.com/use-cases/openai) [GGoogle Gemini](https://www.dreamfactory.com/use-cases/google-gemini) [CAnthropic Claude](https://www.dreamfactory.com/use-cases/anthropic-claude-landing) [LMeta Llama](https://www.dreamfactory.com/use-cases/meta-llama) [MMistral AI](https://www.dreamfactory.com/use-cases/mistral) [CoCohere](https://www.dreamfactory.com/use-cases/cohere) Services and support [Quickstart Service Packages Expert-led Quickstarts to production](https://www.dreamfactory.com/services-and-support/quickstart-services-packages) AI Data Models [Generate & Manage REST APIs From any database, in seconds](https://www.dreamfactory.com/api-management/generate-rest-apis) [Features Security, scripting, self-hosted & more](https://www.dreamfactory.com/api-management/features) [API Generation The complete guide to auto-generated APIs](https://blog.dreamfactory.com/a-complete-guide-to-api-generation) [API Management Concepts, tools, and best practises](https://blog.dreamfactory.com/what-is-api-management-a-brief-overview-of-api-management-concepts-and-tools?_gl=1*jl0njh*_gcl_au*MjQzMjgwMTc3LjE3ODIzMjI3MzY) AI Use Cases [AI Data Access Secure, governed reads for your LLMs](https://www.dreamfactory.com/use-cases/ai-data-access) [MCP Server Drop-in Model Context Protocol](https://www.dreamfactory.com/use-cases/mcp-server) [Legacy Modernization Wrap mainframes with REST](https://www.dreamfactory.com/use-cases/legacy-modernization) [Data Governance Audit every call, enforce every policy](https://www.dreamfactory.com/use-cases/data-governance) [Customer Case Studies](https://www.dreamfactory.com/case-studies) [Energy Modernization](https://www.dreamfactory.com/case-studies/energy-snowflake-modernization) [Government Modernization](https://www.dreamfactory.com/case-studies/government-mainframe-oracle-modernization) [Government Business Intelligence](https://www.dreamfactory.com/case-studies/government-sql-server-bi-analyst-queries) [Manufacturing Modernization](https://www.dreamfactory.com/case-studies/steel-manufacturing-sap-erp-modernization) [Financial Services Investor Portal](https://www.dreamfactory.com/case-studies/financial-services-sql-server-investor-portal) [Non-Profit Partner Data Sharing](https://www.dreamfactory.com/case-studies/non-profit-sql-server-partner-data-sharing) [Professional Services Exec Dashboards](https://www.dreamfactory.com/case-studies/professional-services-erp-dashboards) [Education HR and External Data Sharing](https://www.dreamfactory.com/case-studies/education-student-hr-sql-server-mysql-external-data-sharing) Industries #### [Healthcare HIPAA-grade APIs across EHR, claims, and labs.](https://www.dreamfactory.com/use-cases/healthcare) #### [Financial Services Portfolios, partners, and portals on one layer.](https://www.dreamfactory.com/use-cases/financial-services) #### [Government Modernize mainframes without re-platforming.](https://www.dreamfactory.com/use-cases/government) #### [Manufacturing SAP, MES, and shop-floor data, governed.](https://www.dreamfactory.com/use-cases/manufacturing) SQL Database [SQL SQL Server](https://www.dreamfactory.com/connectors/sql-server) [OR Oracle](https://www.dreamfactory.com/connectors/oracle) [PG PostgreSQL](https://www.dreamfactory.com/connectors/postgresql) [My MySQL](https://www.dreamfactory.com/connectors/mysql) NoSQL & Docs [Dy DynamoDB](https://www.dreamfactory.com/connectors/dynamodb) [Do DocumentDB](https://www.dreamfactory.com/connectors/azure-documentdb) [Mo MongoDB](https://www.dreamfactory.com/connectors/mongodb) [Cb CouchDB](https://www.dreamfactory.com/connectors/couch-db) Cloud Warehouses [S3 S3](https://www.dreamfactory.com/connectors/amazon-s3) [Ab Azureblob](https://www.dreamfactory.com/connectors/azure-blob) [FS FTP/SFTP](https://www.dreamfactory.com/connectors/ftp-sftp) [LS Local Storage](https://www.dreamfactory.com/connectors/local-storage) C & SaaS [Sf Salesforce](https://www.dreamfactory.com/connectors/salesforce) [API REST / SOAP](https://www.dreamfactory.com/connectors/soap-to-rest) [See all 30+ connectors](https://www.dreamfactory.com/connectors) [![back arrow](https://blog.dreamfactory.com/hubfs/raw_assets/public/dreamfactory/images/orange-arrow.svg) Blog](https://blog.dreamfactory.com/) # Naming API Endpoints by Spencer Nguyen ![calendar icon](https://blog.dreamfactory.com/hubfs/raw_assets/public/dreamfactory/images/calendar-icon.svg) January 3, 2026 Table of contents RECOMMENDED ARTICLES - [A Complete Guide to API Generation](https://blog.dreamfactory.com/a-complete-guide-to-api-generation) - [10 Best API Management Tools](https://blog.dreamfactory.com/what-is-api-management-a-brief-overview-of-api-management-concepts-and-tools) - [Creating a Microsoft SQL Server API in Less Than 5 minutes with DreamFactory](https://blog.dreamfactory.com/creating-a-microsoft-sql-server-api-in-less-than-5-minutes-with-dreamfactory) - [Hasura vs. DreamFactory: A Comprehensive Comparison](https://blog.dreamfactory.com/hasura-vs-dreamfactory) - [Build A Snowflake REST API in Less Than 5 Minutes](https://blog.dreamfactory.com/generate-a-snowflake-rest-api-in-less-than-5-minutes) When you write code, you learn quickly that it can be an exacting process. Spaces and semicolons mean something very different to a computer than they do to us. So what’s the best way to document your API in a way that both humans and machines understand? For starters, here are some practices for naming your API endpoints. ### What Are Endpoints? An application programming interface (API) is a piece of software that connects to different programs. There are specific locations that the API accesses to send and receive data. These connection locations are called endpoints. API requests will contain a header, HTTP method, headers, and body. Programs can have multiple endpoints. As an example, Instagram uses the following endpoints in its API: ### [![Server-Stack](https://no-cache.hubspot.com/cta/default/44870387/interactive-179228959126.png)](https://blog.dreamfactory.com/hs/cta/wi/redirect?encryptedPayload=AVxigLLR9DqRoi4xU6yH%2FRLBuTJ%2BspBZfi7LOOjT4ZMcBDvlpJR1mBqjU9V2JAx4HWZlVimfzZJSv8Szyxy36zUHBLwhr50b%2BOzF56BcQL6WBqtwoJQG2nTmI9RAbQe3ljoI1mOkoupvVfW9DyaTcs%2BXkgNMAwPYlLF3rgErT6wG4Y%2FOASRAXg%3D%3D&webInteractiveContentId=179228959126&portalId=44870387) ### Why Good Naming Practices Are Important We’ve said before that your API is only as good as its [documentation](https://blog.dreamfactory.com/7-tips-to-write-great-api-documentation/). Making your documentation easier to read by third parties is part of the API building process. Knowing how to name your endpoints is part of creating clear API documentation. This is no place for freestyling; stick to what developers already know and expect, and they’ll be more inclined to work with your API. Why would you want someone playing around with your API? If you’ve released an open API, that means you’re opening the door for others to add some innovative functionalities. Facebook’s API is a common example of this. If you’ve ever been to a website that invited you to login with your Facebook credentials, they did so with Facebook’s public API. It’s also important to remember that developers aren’t the only ones looking at your API design. You’ll also want to improve readability and make the documentation accessible to the decision makers in management and curious amateurs. In other words, these are people who may not be as familiar with coding. And in the event that you do need API support, making documentation clear and easy to read will help with debugging the code. Best practices for naming API endpoints apply to any programming language you want to work with, from XML to JavaScript to python. ### Some Best Practices If you have any prior experience with coding, some of these practices may feel like second nature to you. Here’s a list of a few tips for naming API endpoints. For more information about best practices for naming API endpoints, read our article [here](https://blog.dreamfactory.com/best-practices-for-naming-rest-api-endpoints/). ### Some Naming Conventions Code typically makes use of lowercase letters the majority of the time. But this can be difficult to read, especially for someone not familiar with your API. Developers have a few ways around this problem to make code easier on the human eye. #### camelCase You may also see this called “dromedary case” or “lowerCamelCase.” The capitalization of camelCase gives a hint at its style. The first letters of each compound word are capitalized except for the first word. This makes the name’s compound nature more visible and easier to read by humans. #### [![DreamFactory_blog_CTA_163x200@2x-May-07-2024-08-15-34-3229-AM](https://no-cache.hubspot.com/cta/default/44870387/interactive-167690643360.png)](https://blog.dreamfactory.com/hs/cta/wi/redirect?encryptedPayload=AVxigLIsTdHdoDFkQte6buEhuWCtFSyBWWanVVHKlkzgzcdFmIdLH6Rap57Ri2X2Q04LnKTdCRuCwrUdKnHLGVb1nOp4aprKknOBGPa7pVACFtYYoduEjncSPtJjAJvMwk1W%2FTKij3QydMbGWLFM5mYAvpzwrDvBvd2Tc2QoXmw0mQVAJE74Iw%3D%3D&webInteractiveContentId=167690643360&portalId=44870387) #### PascalCase Also known as UpperCamelCase, this is like camelCase except the first letters are capitalized. #### snake\_case A common sight when coding in C languages, snake\_case doesn’t use capitalization or word compounding at all. You simply type all letters in lowercase with an underscore (\_) taking the place of spaces. Again, the spelling of this case is an illustration of its style. ### Turning To DreamFactory These conventions may be intimidating to you, especially if you’re not familiar with code. Fortunately, DreamFactory has an API solution. We can build a full-featured, documented, and secure [REST API](https://blog.dreamfactory.com/soap-vs-rest-whats-the-difference/) in minutes for you, so you don’t have to write a single line of code or find the best way to name your resources. But if you do want to try your hand at code, we also have resources, tutorials, and templates available to walk you through each step. Our server-side scripting supports NodeJS, PHP, Python, and V8JS. *Ready to get started? Sign up for our *[*free 14-day trial*](https://genie.dreamfactory.com/)* and do a guided tour of the API creation process today!* TAGS: [api documentation](https://blog.dreamfactory.com/tag/api-documentation) ![Spencer Nguyen](https://blog.dreamfactory.com/hs-fs/hubfs/d0352ad8ab4e13aed9bf6eb0839b43c5.png?width=100&height=100&name=d0352ad8ab4e13aed9bf6eb0839b43c5.png) Spencer Nguyen As a seasoned content moderator with a keen eye for detail and a passion for upholding the highest standards of quality and integrity in all of their work, Spencer Nguyen brings a professional yet empathetic approach to every task. Stay Connected with The Connector Newsletter! Subscribe to stay up-to-date with DreamFactory's latest product updates, API best practices, and tech humor in your inbox. [![Dreamfactory Logo](https://blog.dreamfactory.com/hubfs/raw_assets/public/dreamfactory/images/megamenu/Megamenu-logo.svg)](https://www.dreamfactory.com/) [Call Sales +1 (415) 993-5877](tel:+14159935877) Open – Mon–Fri 9–5 PT [FREE 30 Minute Demo](https://www.dreamfactory.com/demo) #### Follow us - [GitHub](https://github.com/dreamfactorysoftware/dreamfactory) - [Facebook](https://www.facebook.com/dfsoftwareinc/) - [X (Twitter)](https://twitter.com/dfsoftwareinc) - [LinkedIn](https://www.linkedin.com/company/dreamfactory-software) - [YouTube](https://www.youtube.com/c/dreamfactorysoftware) ### Features [Features](https://www.dreamfactory.com/features) [Self hosted](https://www.dreamfactory.com/features#self) [API Generation](https://www.dreamfactory.com/features#api) [Security](https://www.dreamfactory.com/features#secure) [Customization](https://www.dreamfactory.com/features#custom) [Pricing](https://www.dreamfactory.com/pricing) ### Installers [Linux](https://www.dreamfactory.com/features#installer) [Docker](https://www.dreamfactory.com/features#installer) [Kubernetes](https://www.dreamfactory.com/features#installer) ### API Resources [Documentation](https://docs.dreamfactory.com/) [Case Studies](https://www.dreamfactory.com/stories) [White Papers](https://www.dreamfactory.com/resources/whitepapers) [Academy](https://www.dreamfactory.com/academy) [API Calculator](https://calculator.dreamfactory.com) [Open Source](https://github.com/dreamfactorysoftware) ### Company [Blog](https://blog.dreamfactory.com/) [Hub](https://www.dreamfactory.com/hub) [About us](https://www.dreamfactory.com/about) [Partners](https://www.dreamfactory.com/partners) [Support](https://www.dreamfactory.com/support) [Connectors](https://www.dreamfactory.com/connectors) [Contact Us](https://www.dreamfactory.com/demo) © 2025 DreamFactory. All rights reserved. [Terms of Use](https://www.dreamfactory.com/terms-of-use) [Privacy Policy](https://www.dreamfactory.com/privacy-policy) [LLMs](https://www.dreamfactory.com/llms.txt) ```json { "@context" : "https://schema.org", "@type" : "BlogPosting", "author" : { "@type" : "Person", "name" : "Spencer Nguyen", "url" : "https://blog.dreamfactory.com/author/spencernguyen" }, "dateModified" : "2025-03-18T15:49:00.496Z", "datePublished" : "2026-01-04T00:00:00.000Z", "headline" : "Naming API Endpoints", "image" : [ "https://blog.dreamfactory.com/hubfs/Imported_Blog_Media/Image73-1024x576.jpg" ], "mainEntityOfPage" : { "@id" : "https://blog.dreamfactory.com/naming-api-endpoints", "@type" : "WebPage" }, "publisher" : { "@type" : "Organization", "logo" : { "@type" : "ImageObject", "url" : "https://blog.dreamfactory.com/hubfs/DreamFactory%20-%20Orange%20-%20Transparent-1.png" } } } ```