Skip to content

Commit 785ca3b

Browse files
authored
DOCSP-47132: Add new page for Data API alternative (#878)
* Add new page for Data API alternative * Fix code block formatting * Update guide with additional methods and corresponding example commands * Fix code indents * Apply feedback
1 parent f2d7fb8 commit 785ca3b

File tree

4 files changed

+812
-27
lines changed

4 files changed

+812
-27
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ toc_landing_pages = [
3535
"/logs",
3636
"/schemas",
3737
"/data-api",
38+
"/data-api/data-api-deprecation",
3839
"/tutorials",
3940
# App Services CLI
4041
"/cli",

source/data-api/data-api-deprecation.txt

Lines changed: 51 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Data API and HTTPS Endpoints Deprecation
1313
:depth: 2
1414
:class: singlecol
1515

16+
.. toctree::
17+
:titlesonly:
18+
:hidden:
19+
20+
Guide: Implement an Express.js Alternative to the Atlas Data API </data-api/migration/data-api-tutorial>
21+
1622
As of September 2024, Data API and HTTPS Endpoints are deprecated for Atlas App
1723
Services. Data API and HTTPS Endpoints will reach end-of-life and be removed on
1824
**September 30, 2025**. If you use Data API or HTTPS Endpoints, you should
@@ -38,38 +44,45 @@ Express is a popular framework for building restful APIs, which can be leveraged
3844
with the MongoDB native node driver to expose REST API endpoints for your
3945
application.
4046

41-
- `Getting Started with Express, Node, and MongoDB <https://www.mongodb.com/resources/languages/express-mongodb-rest-api-tutorial>`__
42-
- `Express Documentation <https://expressjs.com/>`__
47+
- `Tutorial: Building a REST API with Express, Node, and MongoDB <https://www.mongodb.com/resources/languages/express-mongodb-rest-api-tutorial>`__
48+
- :ref:`Guide: Implement an Express.js Alternative to the Atlas Data API <data-api-custom-express-alternative>`
49+
50+
Refer to the official `Express Documentation <https://expressjs.com/>`__ to
51+
learn more.
4352

4453
Java and SpringBoot
4554
~~~~~~~~~~~~~~~~~~~
4655

4756
Java Spring Boot is a framework that streamlines the creation of
4857
production-ready Spring-based applications with minimal configuration.
4958

50-
- `Getting Started with MongoDB and SpringBoot <https://www.mongodb.com/resources/products/compatibilities/spring-boot#getting-started-with-mongodb-and-spring-boot>`__
51-
- `SpringBoot Documentation <https://docs.spring.io/spring-data/mongodb/reference/>`__
52-
- `SpringBoot MongoDB Guide <https://spring.io/guides/gs/accessing-data-mongodb>`__
59+
- `Tutorial: Getting Started with MongoDB and SpringBoot <https://www.mongodb.com/resources/products/compatibilities/spring-boot#getting-started-with-mongodb-and-spring-boot>`__
60+
- SpringBoot's `Accessing Data with MongoDB <https://spring.io/guides/gs/accessing-data-mongodb>`__
5361

62+
Refer to the official `SpringBoot Documentation <https://docs.spring.io/spring-data/mongodb/reference/>`__ to
63+
learn more.
5464

5565
Python and FastAPI
5666
~~~~~~~~~~~~~~~~~~~
5767

5868
FastAPI is a modern, easy-to-learn, Python 3.6+ framework for building APIs
5969
based on standard Python type hints.
6070

61-
- `Getting Started With MongoDB and FastAPI <https://www.mongodb.com/developer/languages/python/python-quickstart-fastapi/>`__
62-
- `FastAPI Documentation <https://fastapi.tiangolo.com/>`__
71+
- `Quick Start: Getting Started With MongoDB and FastAPI <https://www.mongodb.com/developer/languages/python/python-quickstart-fastapi/>`__
72+
73+
Refer to the official `FastAPI Documentation <https://fastapi.tiangolo.com/>`__ to
74+
learn more.
6375

6476
RESTHeart
6577
~~~~~~~~~
6678

6779
RESTHeart is an open source runtime that leverages MongoDB features via
6880
REST, GraphQL, and WebSocket APIs to provide a persistent data API. RESTHeart
69-
provides REST APIs for MongoDB features, built-in Authentication and Authorization,
81+
provides REST APIs for MongoDB features, built-in authentication and authorization,
7082
and support for Java, Kotlin, JavaScript, and Typescript.
7183

72-
- `RESTHeart documentation <https://restheart.org/docs/>`__
84+
Refer to the official `RESTHeart documentation <https://restheart.org/docs/>`__ to
85+
learn more.
7386

7487

7588
MongoDB Drivers and Cloud Native Functions
@@ -85,10 +98,13 @@ AWS Lambda is a compute service that runs your code in response to events and
8598
automatically manages the compute resources, making it the fastest way to turn
8699
an idea into a modern, production, serverless application.
87100

88-
- `AWS Documentation <https://aws.amazon.com/lambda/>`__
89-
- `Integrate MongoDB Atlas with AWS Lambda using the Node.js Driver <https://www.mongodb.com/developer/products/atlas/serverless-development-lambda-atlas/>`__
90-
- `Serverless Development with Lambda and the MDB Java Driver <https://www.mongodb.com/developer/products/atlas/serverless-development-aws-lambda-mongodb-atlas-using-java/>`__
91-
- `How to use PyMongo to Connect MongoDB Atlas with AWS Lambda <https://www.mongodb.com/developer/products/atlas/awslambda-pymongo/>`__
101+
- `Tutorial: Integrate MongoDB Atlas with AWS Lambda using the Node.js Driver <https://www.mongodb.com/developer/products/atlas/serverless-development-lambda-atlas/>`__
102+
- `Tutorial: Serverless Development with AWS Lambda and the MDB Java Driver <https://www.mongodb.com/developer/products/atlas/serverless-development-aws-lambda-mongodb-atlas-using-java/>`__
103+
- `Tutorial: How to use PyMongo to Connect MongoDB Atlas with AWS Lambda <https://www.mongodb.com/developer/products/atlas/awslambda-pymongo/>`__
104+
105+
Refer to the official `AWS Lambda Documentation
106+
<https://aws.amazon.com/lambda/>`__ to
107+
learn more.
92108

93109
Azure Functions
94110
~~~~~~~~~~~~~~~
@@ -98,29 +114,37 @@ maintain less infrastructure, and save on costs. Instead of worrying about
98114
deploying and maintaining servers, the cloud infrastructure provides all the
99115
up-to-date resources needed to keep your applications running.
100116

101-
- `Azure Documentation <https://learn.microsoft.com/en-us/azure/azure-functions/functions-overview?pivots=programming-language-csharp>`__
102-
- `Integrate Atlas with Azure Functions Tutorial with the .Net Driver for CRUD Operations <https://www.mongodb.com/blog/post/how-to-integrate-azure-functions-with-mongodb>`__
103-
- `Getting Started with MongoDB Atlas and Azure Functions using .Net and C# <https://techcommunity.microsoft.com/t5/apps-on-azure-blog/getting-started-with-mongodb-atlas-and-azure-functions-using-net/ba-p/3741751>`__
117+
- `Tutorial: How to Integrate Azure Functions with MongoDB using the .Net Driver <https://www.mongodb.com/blog/post/how-to-integrate-azure-functions-with-mongodb>`__
118+
- Azure's `Getting Started with MongoDB Atlas and Azure Functions using .Net and C# <https://techcommunity.microsoft.com/t5/apps-on-azure-blog/getting-started-with-mongodb-atlas-and-azure-functions-using-net/ba-p/3741751>`__
104119

120+
Refer to the official `Azure Functions Documentation
121+
<https://learn.microsoft.com/en-us/azure/azure-functions/functions-overview?pivots=programming-language-csharp>`__
122+
to
123+
learn more.
105124

106125
Google Cloud Run Functions
107126
~~~~~~~~~~~~~~~~~~~~~~~~~~
108127

109128
Cloud Run is a managed compute platform that enables you to run containers that
110129
are invocable via requests or events.
111130

112-
- `GCP documentation <https://cloud.google.com/run/docs>`__
131+
Refer to the official `Cloud Run documentation
132+
<https://cloud.google.com/run/docs>`__ to
133+
learn more.
113134

114135
Vercel, Node.js, and Express
115136
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116137

117138
Vercel is a cloud platform that helps developers build, scale, and secure web
118139
applications.
119140

120-
- `Getting Started with Express, Node, and MongoDB <https://www.mongodb.com/resources/languages/express-mongodb-rest-api-tutorial>`__
121-
- `How to Deploy an Express.js Application to Vercel <https://vercel.com/guides/using-express-with-vercel>`__
122-
- `Express Documentation <https://expressjs.com/>`__
141+
- `Tutorial: Building a REST API with Express, Node, and MongoDB <https://www.mongodb.com/resources/languages/express-mongodb-rest-api-tutorial>`__
142+
- `Integrate MongoDB Atlas with Vercel
143+
<https://www.mongodb.com/docs/atlas/reference/partner-integrations/vercel/>`__
144+
- Vercel's `Using Express.js with Vercel <https://vercel.com/guides/using-express-with-vercel>`__
123145

146+
Refer to the official `Vercel Documentation <https://vercel.com/docs/>`__ to
147+
learn more.
124148

125149
Partner Solutions
126150
-----------------
@@ -144,9 +168,10 @@ This abstraction layer enables developers to program with databases through
144168
APIs, simplifying communication between the application and the database and
145169
making it easier and faster to integrate databases into their applications.
146170

147-
Refer to `Neurelo REST API MongoDB Atlas Migration Guide
148-
<https://docs.neurelo.com/guides/mongodb-atlas-migrate-rest-data-apis-to-neurelo>`__
149-
to learn more.
171+
Refer to the following Nuerelo guides to learn more:
172+
173+
- `MongoDB Data API Migration Guide <https://docs.neurelo.com/guides/mongodb-atlas-migrate-rest-data-apis-to-neurelo>`__
174+
- `MongoDB GraphQL API Migration Guide <https://docs.neurelo.com/guides/mongodb-atlas-migrate-graphql-to-neurelo>`__
150175

151176
Hasura
152177
~~~~~~
@@ -157,14 +182,15 @@ times, Hasura enables rapid access to data for next-gen applications and
157182
services, and enables enterprises to shorten time to market on data-powered
158183
products and features.
159184

160-
Refer to `Hasura MongoDB GraphQL API Migration Guide <https://hasura.io/graphql/database/mongodb>`__ to learn more.
185+
Refer to Hasura's `MongoDB GraphQL API Migration Guide
186+
<https://hasura.io/graphql/database/mongodb>`__ to learn more.
161187

162188
Snaplogic
163189
~~~~~~~~~
164190

165191
Snaplogic provides an integration platform for connecting cloud data sources.
166192

167-
Refer to `MongoDB Snap Pack
193+
Refer to SnapLogic's `MongoDB Snap Pack
168194
<https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438065/MongoDB+Snap+Pack>`__
169195
documentation to learn more.
170196

0 commit comments

Comments
 (0)