mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-10 09:29:34 +00:00
14177635b6
# Summary This PR drops the outdated former swagger.yaml/json and introduced automatic API document generation from Go code. The generated code is also used to generate documentation/markdown for the community page, as well as enable the Woodpecker server to serve a Swagger Web UI for manual tinkering. I did opt-in for gin-swagger, a middleware for the Gin framework, to ease implementation and have a sophisticated output. This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi 3x tooling is not yet that mature, so I guess that's fine for now. ## Implemenation notes - former swagger.json files removed - former // swagger godocs removed - introduced new dependency gin-swagger, which uses godoc annotations on top of Gin Handler functions. - reworked Makefile to automatically generate Go code for the server - introduce new dependency go-swagger, to generate Markdown for documentation purposes - add a Swagger Web UI, incl. capabilities for manual API exploration - consider relative root paths in the implementation - write documentation for all exposed API endpoints - incl. API docs in the community website (auto-generated) - provide developer documentation, for the Woodpecker authors - no other existing logic/code was intentionally changed --------- close #292 --------- Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com> Co-authored-by: 6543 <6543@obermui.de>
112 lines
3.6 KiB
Vue
112 lines
3.6 KiB
Vue
<template>
|
|
<Scaffold>
|
|
<template #title>{{ $t('user.settings') }}</template>
|
|
<template #titleActions><Button :text="$t('logout')" :to="`${address}/logout`" /></template>
|
|
<div class="space-y-4 flex flex-col">
|
|
<SelectField v-model="selectedLocale" :options="localeOptions" />
|
|
|
|
<div>
|
|
<div class="flex items-center mb-2">
|
|
<h2 class="text-lg text-color">{{ $t('user.token') }}</h2>
|
|
<Button class="ml-4" :text="$t('user.reset_token')" @click="resetToken" />
|
|
</div>
|
|
<pre class="cli-box">{{ token }}</pre>
|
|
</div>
|
|
|
|
<div>
|
|
<h2 class="text-lg text-color">{{ $t('user.shell_setup') }}</h2>
|
|
<pre class="cli-box">{{ usageWithShell }}</pre>
|
|
</div>
|
|
|
|
<div>
|
|
<div class="flex items-center">
|
|
<h2 class="text-lg text-color">{{ $t('user.api_usage') }}</h2>
|
|
<a :href="`${address}/swagger/index.html`" target="_blank" class="ml-4 text-link">Swagger UI</a>
|
|
</div>
|
|
<pre class="cli-box">{{ usageWithCurl }}</pre>
|
|
</div>
|
|
|
|
<div>
|
|
<div class="flex items-center">
|
|
<h2 class="text-lg text-color">{{ $t('user.cli_usage') }}</h2>
|
|
<a :href="cliDownload" target="_blank" class="ml-4 text-link">{{ $t('user.dl_cli') }}</a>
|
|
</div>
|
|
<pre class="cli-box">{{ usageWithCli }}</pre>
|
|
</div>
|
|
</div>
|
|
</Scaffold>
|
|
</template>
|
|
|
|
<script lang="ts" setup>
|
|
import { useLocalStorage } from '@vueuse/core';
|
|
import dayjs from 'dayjs';
|
|
import TimeAgo from 'javascript-time-ago';
|
|
import { SUPPORTED_LOCALES } from 'virtual:vue-i18n-supported-locales';
|
|
import { computed, onMounted, ref } from 'vue';
|
|
import { useI18n } from 'vue-i18n';
|
|
|
|
import Button from '~/components/atomic/Button.vue';
|
|
import SelectField from '~/components/form/SelectField.vue';
|
|
import Scaffold from '~/components/layout/scaffold/Scaffold.vue';
|
|
import useApiClient from '~/compositions/useApiClient';
|
|
import { setI18nLanguage } from '~/compositions/useI18n';
|
|
|
|
const { t, locale } = useI18n();
|
|
|
|
const apiClient = useApiClient();
|
|
const token = ref<string | undefined>();
|
|
|
|
onMounted(async () => {
|
|
token.value = await apiClient.getToken();
|
|
});
|
|
|
|
// eslint-disable-next-line no-restricted-globals
|
|
const address = `${location.protocol}//${location.host}`; // port is included in location.host
|
|
|
|
const usageWithShell = computed(() => {
|
|
let usage = `export WOODPECKER_SERVER="${address}"\n`;
|
|
usage += `export WOODPECKER_TOKEN="${token.value}"\n`;
|
|
return usage;
|
|
});
|
|
|
|
const usageWithCurl = `# ${t(
|
|
'user.shell_setup_before',
|
|
)}\ncurl -i \${WOODPECKER_SERVER}/api/user -H "Authorization: Bearer \${WOODPECKER_TOKEN}"`;
|
|
|
|
const usageWithCli = `# ${t('user.shell_setup_before')}\nwoodpecker info`;
|
|
|
|
const cliDownload = 'https://github.com/woodpecker-ci/woodpecker/releases';
|
|
|
|
const localeOptions = computed(() =>
|
|
SUPPORTED_LOCALES.map((supportedLocale) => ({
|
|
value: supportedLocale,
|
|
text: new Intl.DisplayNames(supportedLocale, { type: 'language' }).of(supportedLocale) || supportedLocale,
|
|
})),
|
|
);
|
|
|
|
const storedLocale = useLocalStorage('woodpecker:locale', locale.value);
|
|
const selectedLocale = computed<string>({
|
|
async set(_selectedLocale) {
|
|
await setI18nLanguage(_selectedLocale);
|
|
storedLocale.value = _selectedLocale;
|
|
dayjs.locale(_selectedLocale);
|
|
TimeAgo.setDefaultLocale(_selectedLocale);
|
|
},
|
|
get() {
|
|
return storedLocale.value;
|
|
},
|
|
});
|
|
|
|
const resetToken = async () => {
|
|
token.value = await apiClient.resetToken();
|
|
window.location.href = `${address}/logout`;
|
|
};
|
|
</script>
|
|
|
|
<style scoped>
|
|
.cli-box {
|
|
@apply bg-gray-500 p-2 rounded-md text-white break-words dark:bg-dark-400 dark:text-gray-400;
|
|
white-space: pre-wrap;
|
|
}
|
|
</style>
|