diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 658bee2..63613c4 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,10 +1,12 @@ :description: The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests. + = Introduction [WARNING] ==== -The HTTP API is currently not available on link:{neo4j-docs-base-uri}/aura[Neo4j Aura]. +The HTTP API is not available on <>. +Use the link:{neo4j-docs-base-uri}/query-api/current/[Query API] instead. ==== The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo4j server through HTTP requests. @@ -12,19 +14,18 @@ The Neo4j HTTP API allows to execute a series of Cypher statements against a Neo The main use case of the HTTP API is for developing client applications in languages for which there is no supported library. If there exists an official library (driver) for the language you are using, consider using that instead -- see link:{neo4j-docs-base-uri}/create-applications/[Create applications]. +By default, the API uses port 7474 for HTTP and port 7473 for HTTPS. + This guide assumes that you have: -- a running Neo4j instance -- if not, check out how to link:{neo4j-docs-base-uri}/operations-manual/current/installation/[install Neo4j] -- some familiarity with <> -- if you need a hand, check out link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Getting started -> Cypher]. +- A running instance of Neo4j -- If you don't have one, link:https://neo4j.com/docs/operations-manual/current/installation/[install Neo4j locally] or sign up for an link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura cloud instance]. +- Some familiarity with <> -- If you are new to it, check out link:https://neo4j.com/docs/getting-started/cypher-intro/[Getting started -> Cypher]. To execute queries through the HTTP API, you may use either: - xref:query.adoc[Implicit transactions] -- you just submit queries, the API takes care of the transaction handling for you - xref:transactions.adoc[Explicit transactions] -- you control the lifecycle of the transaction (open, commit, rollback), within which you can execute queries. -[TIP] -By default, the HTTP API uses port 7474 for HTTP and port 7473 for HTTPS. - [NOTE] As of Neo4j 5.17, the HTTP API supports HTTP/2 as well as HTTP/1.1, unless either is explicitly disabled in the server configuration setting link:https://neo4j.com/docs/operations-manual/5/configuration/configuration-settings/#config_server.http_enabled_transports[`server.http_enabled_transports`]. It's up to the client to initiate a connection with the preferred protocol. diff --git a/modules/ROOT/partials/glossary.adoc b/modules/ROOT/partials/glossary.adoc index 85150a1..fa70300 100644 --- a/modules/ROOT/partials/glossary.adoc +++ b/modules/ROOT/partials/glossary.adoc @@ -1,4 +1,6 @@ [glossary] +[[Aura]]Aura:: link:https://neo4j.com/cloud/platform/aura-graph-database/[Aura] is Neo4j's fully managed cloud service. +It comes with both free and paid plans. [[Cypher]]Cypher:: link:{neo4j-docs-base-uri}/getting-started/cypher-intro/[Cypher] is Neo4j's graph query language that lets you retrieve data from the database. It is like SQL, but for graphs. [[ACID]]ACID:: Atomicity, Consistency, Isolation, Durability (ACID) are properties guaranteeing that database transactions are processed reliably. diff --git a/preview.yml b/preview.yml index 3619f3b..9ba7204 100644 --- a/preview.yml +++ b/preview.yml @@ -39,6 +39,7 @@ asciidoc: page-origin-private: false page-hide-toc: false page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575 + page-role: not-on-aura includePDF: false nonhtmloutput: "" experimental: '' diff --git a/publish.yml b/publish.yml index 14cd8af..e967dd2 100644 --- a/publish.yml +++ b/publish.yml @@ -46,6 +46,7 @@ asciidoc: page-origin-private: false page-hide-toc: false page-mixpanel: 4bfb2414ab973c741b6f067bf06d5575 + page-role: not-on-aura includePDF: false nonhtmloutput: "" experimental: ''