introduction.mdx 875 B

123456789101112131415161718192021222324252627282930313233
  1. ---
  2. title: "Introduction"
  3. description: "Example section for showcasing API endpoints"
  4. ---
  5. <Note>
  6. If you're not looking to build API reference documentation, you can delete this section by removing the api-reference
  7. folder.
  8. </Note>
  9. ## Welcome
  10. There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
  11. <Card
  12. title="Plant Store Endpoints"
  13. icon="leaf"
  14. href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
  15. >
  16. View the OpenAPI specification file
  17. </Card>
  18. ## Authentication
  19. All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
  20. ```json
  21. "security": [
  22. {
  23. "bearerAuth": []
  24. }
  25. ]
  26. ```