Commit 85cf733c authored by Markus Scheidgen's avatar Markus Scheidgen
Browse files

Updated API overview GUI page. #408

parent 2f19496e
......@@ -145,7 +145,6 @@ dev setup tests:
image: python:3.7
script:
- pip install --upgrade pip
- find dependencies -type d -name "*.egg-info" -exec rm -rf {} \;
- ./setup.sh
- python -m nomad.cli parse tests/data/parsers/vasp/vasp.xml
except:
......
......@@ -17,7 +17,7 @@
*/
import { makeStyles } from '@material-ui/core'
import React from 'react'
import { apiBase, appBase, optimadeBase } from '../config'
import { apiBase, appBase } from '../config'
import Markdown from './Markdown'
const useStyles = makeStyles(theme => ({
......@@ -37,9 +37,20 @@ export default function About() {
# APIs
NOMAD's Application Programming Interface (API) allows you to access NOMAD data
and functions programatically.
and functions programatically. For all APIs, we offer dashboards that let you use
each API interactively, right in your browser.
## NOMAD's main API
## NOMAD's new (Version 1) API
- [API dashboard](${apiBase}/v1/extensions/docs)
- [API documentation](${apiBase}/v1/extensions/redoc)
We started to implement a more consise and easier to use API for access NOMAD
data. This will step-by-step reimplement all functions of NOMAD's old main API.
At some point, it will replace it entirely. For new users, we recommend to start
using this API. API Dashboard and documentation contain a tutorial on how to get started.
## NOMAD's main (Version 0) API
- [API dashboard](${apiBase}/)
......@@ -54,7 +65,9 @@ export default function About() {
## OPTIMADE
- [OPTIMADE API dashboard](${optimadeBase}/)
- [OPTIMADE API overview page](${appBase}/optimade/)
- [OPTIMADE API dashboard](${appBase}/optimade/v1/extensions/docs)
- [OPTIMADE API documentation](${appBase}/optimade/v1/extensions/redoc)
[OPTIMADE](https://www.optimade.org/) is an
open API standard for materials science databases. This API can be used to search
......
......@@ -22,8 +22,6 @@ export const version = window.nomadEnv.version
export const appBase = window.nomadEnv.appBase.replace(/\/$/, '')
// export const apiBase = 'http://nomad-lab.eu/prod/rae/api'
export const apiBase = `${appBase}/api`
export const apiV1Base = `${appBase}/api/v1`
export const optimadeApi = `${appBase}/optimade/v1/extensions/docs`
export const guiBase = process.env.PUBLIC_URL
export const matomoUrl = window.nomadEnv.matomoUrl
export const matomoSiteId = window.nomadEnv.matomoSiteId
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment