Specification to transform normal site or App to an API.
We create open-crawler api-spec by modified some section of Open API.
We are always following the stable version of OAI. For now the version of OAI is 3.0.2, and our open-crawler api-spec also is 3.0.2. In the feature the stable of OAI will be 3.0.3, at that time we will update our open-crawl-spec version to follow the newer version as soon as possible. At sometime, maybe the changes of newer version of OAI have zero feature for our open-crawler api-spec, and we will not to update the version.
The detail of specification can be found here.
The open-crawler api-spec contains 2 parts of specifications:
- API defines of site's paths;
- Data parser schema for each path's response.
The open-crawler api-spec is trying to make every sites served as API service. Then everyone can use the API to create their APPs or just take the data away like a thief.
For now we only supported:
🔥 We are trying to create a community.
The current process for development of the open-crawler api-spec is described in Development Guidelines.
The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving open-crawler api-spec. Participation in weekly calls and scheduled working sessions is open to the community. You can view the TSC calendar online.
The open-crawler api-spec encourages participation from individuals and companies alike. If you want to participate in the evolution of the open-crawler api-spec, consider taking the following actions:
- Review the current specification. The human-readable markdown file is the source of truth for the specification.
- Review the development process so you understand how the spec is evolving.
- Check the issues and pull requests to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by adding a comment to the existing issue or PR.
- Create an issue to describe a new concern. If possible, propose a solution.
More detail you can check the CONTRIBUTING
Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.
See: License (Apache-2.0)