At Apigit, we strive to democratize APIs and empower users to utilize and construct APIs with the Apigit API Platform to enable a thriving API-first world. We continue to provide access to the best opportunities Apigit has to offer – from newcomers to advanced users.
To access any of the specific features listed below, you must first create an Apigit account and sign in. Apigit can be accessed directly from your preferred browser.
After logging in, you can explore these five exciting features to get started with Apigit.
After creating your Apigit account, you can explore the platform's various features, including creating a repository. A repository is a space where you can store your code and collaborate with others.
To create a repository, open the Repository page of your Apigit dashboard and click on the Create Repository button. First choose where the repository is hosted, then enter a name and optional description for your repository, and confirm to finalize the process.
Congratulations, you have successfully created your first repository on Apigit! You can now start adding files, collaborating with others, and utilizing the platform's many other features.
First step: Create a repository
To add an API specification to your repository, click on the + sign above the file list. Input a pathname, such as test/myfirst.json, along with other relevant information like the title and version.
The create-file dialog offers OpenAPI Spec, AsyncAPI Spec, GraphQL Schema, JSON Schema Spec, Markdown Document and Navigation. To try the OpenAPI example first, select example/petstore.json and choose code from its file menu to inspect the source. See Supported API Formats for the editing tools available for each format.
To edit your API specification, select the file and click on the ✏️ icon located at the bottom left of the dashboard. You can then copy the JSON code from the example and use it to create your own specification. Here's an example of what your first API specification could look like.
Second step: Add an api spec
Mock servers are often used in API development to simulate the behavior of an API before it is fully implemented. Developers can use mock servers to test their code and ensure that it is working as expected, without having to wait for the API to be completed or having to make requests to a real server.
Deploying a mock server in Apigit is a simple process. Open your repository, click on Publish and choose Publish MockServer. Spec-based is already selected, so check the API specification from step 2 and click Start deploy: you write no code. You can then find the server URL in the repository's Publish Center. See the quick start.
Third step: Create and publish a mock server
A published API document is a versioned, shareable site built from the API specification and Markdown files in your repository, released from a git commit so it never drifts from what the code actually does.
To publish one, open the Publish Center of your repository and choose Publish API & Doc. Pick the commit (or branch) to release, give the version a name, and APIGit renders the specification you added in step 2 into a browsable document site. You can then share it with internal or external viewers, protect it with access permissions, or serve it from your own custom domain.
Apigit is a popular API collaboration platform that enables easy sharing of work. Whether you're working on a small project with a single friend or are part of an enterprise company with hundreds of developers actively working on a public API, you have control over what is visible and to whom.
If you've created something that you believe the world should see, you can publish a document as Public To All on any plan, and anyone can read it. Free includes the APIGit badge. See Share API Documents.
Now that you've mastered some of the basics, take some time to explore and discover more useful functions on Apigit. For instance, did you know that you can check API governance rules in pull requests of an organization repository, or, on the Enterprise plan, mirror your repository to GitHub, GitLab or Bitbucket? Explore this and many other helpful tools available on the platform.
AsyncAPI browser governance, hosted GraphQL mocks and generated agent pages are live. See the workflows and limits, with AsyncAPI and GraphQL lint in CLI 0.6.0 and hosted server lint availability tracked separately.
Create, edit and publish AsyncAPI documents and GraphQL schemas alongside OpenAPI. One Redoc 3 viewer, full-panel code editing and a clear guide to what each format supports.
This article explains the different components of a REST API by following a request from end to end. An API client is responsible for assembling and directing an API request to the API server. An API request to a REST API consists of an endpoint, method, parameters, request headers, and a request body. The API server handles authentication, validates input data, retrieves or manipulates data from a database, and returns the appropriate response to the client. An API response typically includes a status code, response headers, and a body. API status codes are used to provide information to the client about the outcome of the request and to help the client understand how to proceed. Response headers and bodies provide additional information and data about the response.
Create a free workspace, add an OpenAPI file and publish your first API document and mock server in minutes.