Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I need to code the program to generate the stubs in Java using swagger-codegen, for the api.github.com.
For that, I need as an input the swagger specification for api.github.com: where can I find it?
As of July 2020, GitHub publishes its REST API definitions in OpenAPI 3.0 format here:
https://github.com/github/rest-api-description
Official announcement:
OpenAPI Description of REST API
GitHub published a full description of its REST API in OpenAPI 3.0 specification compliant documents.
The GitHub OpenAPI description contains more than 600 operations exposed in our API.
For visual exploration of the API, you can load the description as a Postman Collection.
Programmatically, the description can be used to generate mock servers, test suites, and bindings for languages not supported by Octokit.
The description is provided under two formats.
The bundled version is preferred for most use cases as it makes use of OpenAPI components for reuse and readability.
For tooling that has poor support for inline references to components, we also provide a fully dereferenced version.
Quarterly releases of the description are available for GitHub Enterprise Server and GitHub Private Instances, with versions like v2.21. More frequent updates to the description will be available for GitHub.com.
This feature is offered in beta as open source with an MIT license, [in this repository github/rest-api-description.
APIs.guru OpenAPI directory also contains unofficial definitions for GitHub REST API in OpenAPI 2.0 format, which may or may not be up-to-date:
https://api.apis.guru/v2/specs/github.com/v3/swagger.json (JSON)
https://api.apis.guru/v2/specs/github.com/v3/swagger.yaml (YAML)
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed last month.
Improve this question
As a best practice, I wanted to incorporate some important and critical helpful content into my API specifications
FAQs related to APIs
Code template or cookbook to help the consumer to see the code sample to call the API
API subscription plan
Service level objectives
Service layer agreements
Performance-related details like caching.
I went through the official document of OAM 3.0 seems like there are no direct tags available to define these things.
As per my understanding, these are defined at some other places where APIs are managed. There are not many examples available over the internet to help with this requirement.
I did use Swaggerhub and Anypoint platform to create open API specifications using version 3.0
I don't think OpenAPI specification is expressive enough to cover this, so it is better to cover them in a separate narrative documentation that you link from your specification.
For writing the narrative documentation, documentation management open-source tools include ones like
Sphinx
MkDocs
You can add narrative links in the description section of your YAML file.
See an example here.
Example YAML:
openapi: 3.0.2
info:
title: Open DeFi API
description: |
Long Markdown description goes here.
Add links here to your documentation here.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 3 years ago.
Improve this question
im trying to create an OGC API Features server.
I know there is a community module named ogcapi for GeoServer and i was able to install the module (by copying all classes of the ogcapi module into the geoserver/web-inf/lib folder of my apache tomcat)
I can see the new Service Capabilities in the Web administration interface but i have no idea how to move on. There is no further possibility in the Services Panel.
Is there any documentation on how to use the ogcapi-plugin? Does anybody already use it and can give some hints on how to move on?
Im thankful for every help approach.
As a community module, you should be using a nightly build of the development version of GeoServer, along with the corresponding OGC API module.
If you have them installed, you'll get something like this in the home page:
The FEATURES 1.0 link will bring you to the landing page of the OGC Feature API implementation. From there, you can use information from the Features API specification itself to use the API.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 2 years ago.
Improve this question
Do you know any good tools to support the translation of .arb files?
It's a standard for Flutter and since Google Translator Toolkit will be sunset soon (https://support.google.com/translatortoolkit/answer/9462068) we're searching for a good solution to translate/gather our translations
Edit (June 2020): There's great new open source project called Arbify. This is a self-hosted tool to manage multiple translation projects focused on Flutter. You can edit arb files and fetch them via Dart package tool.
Aside from that some services like POEditor have announced basic support for ARB too.
At the moment the best support for arb files is on Localizely. However, this is a paid service and has strict limits on a free version. It allows to export arb translation files with plurals and placeholder support. It doesn't support genders, though.
There is also one simple web editor and one desktop editor (Babel) that support arb files.
Crowdin supports .arb:
https://support.crowdin.com/supported-formats/
It is also able to pull the data from a Git repo and send Pull Requests on GitHub.
However, when I used it in 2018 there was a problem of ##last_modified attribute being updated without any other changes to the translation files, causing lots of churn in PRs. By that time, they were reluctant to improve the situation (based on email conversation with their support), so we resorted to manual edits.
https://localise.biz/ allows 2000 translations. Which I assume are 1000 strings in 2 languages or ~666 strings in 3 languages and so on. Which is more than https://localizely.com/ 150 strings
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 3 years ago.
Improve this question
I'm interested in ESAPI to use in a production environment.
Is there any official documentation on how to setup properly a web application, and if so, where?
ESAPI has good intentions, it is referenced de facto in OWASP Top 10 issues.
However its main development is not really active. The library is provided as is.
There are two Java libraries depending on the versions:
OWASP Enterprise Security API for Java: version >= 3.x
Maintained by one contributor (Chris Schmidt), last code commit (as of today) was on Nov 20, 2013.
Enterprise Security API for Java (Legacy): version <= 2.x
Maintained by at least 3 contributors, last code commit (as of today) was on May 30, 2015.
There is a wish to have documentation (https://www.owasp.org/index.php/ESAPI_Documentation), especially: How to Use ESAPI in a New Application.
But currently, it is really light...
As of March 2014 the project was downgraded away from flagship status (http://off-the-wall-security.blogspot.fr/2014/03/esapi-no-longer-owasp-flagship-project.html). (credits to avgvstvs)
If you still want to learn ESAPI, the best you can have currently:
The ESAPI swing set, a "web application which demonstrates the many uses of the ESAPI" (https://www.owasp.org/index.php/ESAPI_Swingset)
The tests of the legacy version (https://github.com/ESAPI/esapi-java-legacy/tree/master/src/test/java/org/owasp/esapi).
The wiki of the legacy version (https://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API)
The mailing list archives (http://lists.owasp.org/pipermail/esapi-dev/)
The README on the new version annonce new stuff to come:
2 Sept 2014 - We are gearing up to get some great stuff done at AppSecUSA in Denver this month. We'll be announcing our schedule and where we'll be at the conference soon! Stay tuned!
Maybe the doc will arrive one day...
If you want to learn secure programming with ESAPI, check out the ESAPI swing set: https://www.owasp.org/index.php/ESAPI_Swingset
However, as superbob has pointed out, you probably shouldn't use it in new production applications.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 2 years ago.
Improve this question
I am trying to integrate an external system with jenkins by REST API.
Although I have done lots of google search on its API reference, I still cannot get a full list of jenkins REST API reference.
Anybody knows about this?
Jenkins has a link to their REST API in the bottom right of each page.
This link appears on every page of Jenkins and points you to an API output for the exact page you are browsing. That should provide some understanding into how to build the API URls.
You can additionally use some wrapper, like I do, in Python, using http://jenkinsapi.readthedocs.io/en/latest/
Here is their website: https://wiki.jenkins-ci.org/display/JENKINS/Remote+access+API
Additional Solution: use Restul api wrapper libraries written in Java / python / Ruby - An object oriented wrappers which aim to provide a more conventionally way of controlling a Jenkins server.
For documentation and links: Remote Access API