# 👋 Welcome to The McLane API Designer Platform #### With Stoplight, you can: >### 💡 Design, mock, test and document APIs. > ### What is Stoplight? Stoplight is a collaborative platform equipping APIM team with tooling across the API lifecycle that helps them build quality APIs efficiently. [Refer documentation to learn more](https://meta.stoplight.io) ### Who is it for? EA, BA & API developers, and anyone who wants to learn about McLane API ecosystem and design first approach ### Benefits - Create and update API designs and documentation - Share interactive documentation with internal and external stakeholders - Explore your APIs, track dependencies and view changelogs - Invite team members to collaborate on API assets --- ### API Design First Approach - [Promotes standards and best practice for consistency](https://devops.mclaneco.com/standards/api/design/index.html) - Prioritizes creating API model - Reuses common elements/libraries - Collaborate and review with stakeholders/BA for feedback - [Design First - High Level Diagram](https://mclane-company-inc.stoplight.io/docs/apim-standards-best-practices/vigoju1f5pvgt-api-development-design-first-approach) ## Getting Started > 💡 Developers Guide. > > Detailed step by step developers' resource is published on our standards and best practices website [How to use DevOps360 portal](https://devops.mclaneco.com/standards/devops/cicd/devops-360-new-app-overview.html). - Locate Technical Spec Document (TSD) for your project in API Catalog [Here](https://mclane-company-inc.stoplight.io/explore) - Create api implementation repo in project API Management using the [DevOps360 portal](https://devops.mclaneco.com/devops-360) - Create implementation code and commits to api implementation repo - Application deployed to OpenShift - API Management objects are built via automation if required - Support API go-live & postproduction >The links in this developers Guide section are only accessible via VPN access. --- ## Collaborate and Discuss > 💡 Bring stakeholders and partners onboard with flexible permissions to start sharing collaborating on your design assets. > --- ![explore-icon](https://img.icons8.com/cotton/64/000000/search-in-cloud.png) ## Explore APIs [Explore available API Projects](https://mclane-company-inc.stoplight.io/explore) Find APIs, star reusable elements, track dependencies, and try out hosted mocks using Explorer. --- ![tutorial-icon](https://img.icons8.com/cotton/128/000000/abc.png) ## Tutorials > 💡 Refer public projects in dedicated tutorials and walkthroughs. Notice the tabs? 😉 Read more about [Stoplight Flavored Markdown](https://meta.stoplight.io/docs/platform/ZG9jOjM3MTUxNjgw-stoplight-flavored-markdown). ![faqs-icon](https://img.icons8.com/cotton/64/000000/scroll--v1.png) #### Design Help architects design beautiful APIs quickly. [Learn more](https://meta.stoplight.io/docs/platform/ZG9jOjM2OTM3Mjg5-overview) ![documentation-icon](https://img.icons8.com/cotton/64/000000/spaceship-launch-documentation.png) #### Developer Experience Accommodate an amazing developer experience for internal and external developers. [Learn more](https://meta.stoplight.io/docs/platform/ZG9jOjU4NzU5Mg-types-of-documentation) Can't find what you're looking for? [Contact sales](#were-here-to-help) --- ## FAQs > 💡 Add a section for FAQs to help users solve issues quickly. > > Adding links and icons can be useful. *Reminder: This a template - with useful tips and trick though* **Can I get Studio access?** Yes, if your team designer permission is approved you can submit Jira request to add editor permission and access Studio. **Where Is the starter OAS model found for my API project?** If you used [DevOps360 portal](https://devops.mclaneco.com/devops-360) to create your API then the OAS template is autogenerated and integrated to your stoplight git project. If you have manually generated OAS Model please [Contact APIM Team at](mailto:apimadmin@mclaneco.com) **How do I update the documentation?** Documentation is always in sync with changes that you make in your Bitbucket repo. The content in your Bitbucket repository is your source of truth for the documentation. --- ![support-icon](https://img.icons8.com/cotton/64/000000/technical-support.png) ## We're Here to Help > 💡 > Get in touch and let us know how we can help. Ask a peer in our community forum about how they use the Stoplight Platform. [Go to Community](https://community.stoplight.io) [Contact APIM Team at](mailto:apimadmin@mclaneco.com) to get help from our team of in-house experts. > If you are a member of this workspace, please log in [here](auth)